ruport 1.2.2 → 1.2.3

data/Rakefile

@@ -3,7 +3,7 @@ require "rake/testtask"
 require "rake/gempackagetask"
 #
 
-RUPORT_VERSION = "1.2.2"
+RUPORT_VERSION = "1.2.3"
 
 begin
   require "rubygems"

data/examples/png_embed.rb

@@ -54,7 +54,6 @@ end
 
 formats = [:html, :pdf]
 formats.each do  |format|
-  File.open("roadmap.#{format}","w") do |f|
-    f << RoadmapRenderer.render(format, :image_file => "roadmap.png")
-  end
+  RoadmapRenderer.render(format, :image_file => "roadmap.png", 
+                                 :file => "roadmap.#{format}")
 end

data/lib/ruport.rb

@@ -12,7 +12,7 @@
 
 module Ruport #:nodoc:#
   
-  VERSION = "1.2.2"   
+  VERSION = "1.2.3"   
   
   class FormatterError < RuntimeError #:nodoc:
   end

data/lib/ruport/formatter/csv.rb

@@ -43,8 +43,7 @@ module Ruport
       apply_table_format_template(template.table_format)
       apply_grouping_format_template(template.grouping_format)
 
-      options.format_options = template.format_options if
-        template.format_options
+      options.format_options ||= template.format_options
     end
 
     # Generates table header by turning column_names into a CSV row.
@@ -122,16 +121,16 @@ module Ruport
     end
     
     def apply_table_format_template(t)
-      t = t || {}
-      options.show_table_headers = t[:show_headings] unless
-        t[:show_headings].nil?
+      t = (t || {}).merge(options.table_format || {})
+      options.show_table_headers = t[:show_headings] if
+        options.show_table_headers.nil?
     end
     
     def apply_grouping_format_template(t)
-      t = t || {}
-      options.style = t[:style] if t[:style]
-      options.show_group_headers = t[:show_headings] unless
-        t[:show_headings].nil?
+      t = (t || {}).merge(options.grouping_format || {})
+      options.style ||= t[:style]
+      options.show_group_headers = t[:show_headings] if
+        options.show_group_headers.nil?
     end
     
   end

data/lib/ruport/formatter/html.rb

@@ -148,16 +148,16 @@ module Ruport
     end
     
     def apply_table_format_template(t)
-      t = t || {}
-      options.show_table_headers = t[:show_headings] unless
-        t[:show_headings].nil?
+      t = (t || {}).merge(options.table_format || {})
+      options.show_table_headers = t[:show_headings] if
+        options.show_table_headers.nil?
     end
     
     def apply_grouping_format_template(t)
-      t = t || {}
-      options.style = t[:style] if t[:style]
-      options.show_group_headers = t[:show_headings] unless
-        t[:show_headings].nil?
+      t = (t || {}).merge(options.grouping_format || {})
+      options.style ||= t[:style]
+      options.show_group_headers = t[:show_headings] if
+        options.show_group_headers.nil?
     end
 
   end

data/lib/ruport/formatter/pdf.rb

@@ -194,7 +194,7 @@ module Ruport
       y = image_opts[:y]
       width = image_opts[:width]
       height = image_opts[:height]
-      info = ::PDF::Writer::Graphics::ImageInfo.new(File.read(path))
+      info = ::PDF::Writer::Graphics::ImageInfo.new(File.open(path, "rb"))
 
       # reduce the size of the image until it fits into the requested box
       img_width, img_height =
@@ -554,21 +554,23 @@ module Ruport
     end
     
     def apply_page_format_template(t)
-      t = t || {}
-      options.paper_size = t[:size] if t[:size]
-      options.paper_orientation = t[:layout] if t[:layout]
+      t = (t || {}).merge(options.page_format || {})
+      options.paper_size ||= t[:size]
+      options.paper_orientation ||= t[:layout]
     end
     
     def apply_text_format_template(t)
-      options.text_format = template.text_format if t
+      t = (t || {}).merge(options.text_format || {})
+      options.text_format = t unless t.empty?
     end
 
     def apply_table_format_template(t)
-      options.table_format = template.table_format.dup if t
+      t = (t || {}).merge(options.table_format || {})
+      options.table_format = t unless t.empty?
     end
     
     def apply_column_format_template(t)
-      t = t || {}
+      t = (t || {}).merge(options.column_format || {})
       column_opts = {}
       column_opts.merge!(:justification => t[:alignment]) if t[:alignment]
       column_opts.merge!(:width => t[:width]) if t[:width]
@@ -587,7 +589,7 @@ module Ruport
     end
     
     def apply_heading_format_template(t)
-      t = t || {}
+      t = (t || {}).merge(options.heading_format || {})
       heading_opts = {}
       heading_opts.merge!(:justification => t[:alignment]) if t[:alignment]
       heading_opts.merge!(:bold => t[:bold]) unless t[:bold].nil?
@@ -619,8 +621,8 @@ module Ruport
     end
     
     def apply_grouping_format_template(t)
-      t = t || {}
-      options.style = t[:style] if t[:style]
+      t = (t || {}).merge(options.grouping_format || {})
+      options.style ||= t[:style]
     end
   end
 end

data/lib/ruport/formatter/template.rb

@@ -7,6 +7,8 @@
 # This is free software. Please see the LICENSE and COPYING files for details.
 
 
+class Ruport::Formatter::TemplateNotDefined < StandardError; end       
+
 # This class provides templating functionality for Ruport.
 # New templates are created using the Template.create method.
 #
@@ -162,6 +164,6 @@ class Ruport::Formatter::Template < Ruport::Renderer::Options
   
   # Returns an existing template with the provided name (label).
   def self.[](label) 
-    templates[label]
+    templates[label] or raise Ruport::Formatter::TemplateNotDefined
   end
-end
+end   

data/lib/ruport/formatter/text.rb

@@ -218,24 +218,24 @@ module Ruport
     private
     
     def apply_table_format_template(t)
-      t = t || {}
-      options.show_table_headers = t[:show_headings] unless
-        t[:show_headings].nil?
-      options.table_width = t[:width] if t[:width]
-      options.ignore_table_width = t[:ignore_width] unless
-        t[:ignore_width].nil?
+      t = (t || {}).merge(options.table_format || {})
+      options.show_table_headers = t[:show_headings] if
+        options.show_table_headers.nil?
+      options.table_width ||= t[:width]
+      options.ignore_table_width = t[:ignore_width] if
+        options.ignore_table_width.nil?
     end
     
     def apply_column_format_template(t)
-      t = t || {}
-      options.max_col_width = t[:maximum_width] if t[:maximum_width]
-      options.alignment = t[:alignment] if t[:alignment]
+      t = (t || {}).merge(options.column_format || {})
+      options.max_col_width ||= t[:maximum_width]
+      options.alignment ||= t[:alignment]
     end
     
     def apply_grouping_format_template(t)
-      t = t || {}
-      options.show_group_headers = t[:show_headings] unless
-        t[:show_headings].nil?
+      t = (t || {}).merge(options.grouping_format || {})
+      options.show_group_headers = t[:show_headings] if
+        options.show_group_headers.nil?
     end
 
   end

data/lib/ruport/renderer.rb

@@ -524,6 +524,8 @@ class Ruport::Renderer
   def use_formatter(format)
     self.formatter = self.class.formats[format].new
     self.formatter.format = format
+  rescue NoMethodError
+    raise UnknownFormatError
   end
 
 end

data/test/csv_formatter_test.rb

@@ -9,6 +9,19 @@ class TestRenderCSVRow < Test::Unit::TestCase
 end
 
 class TestRenderCSVTable < Test::Unit::TestCase
+  
+  def setup
+    Ruport::Formatter::Template.create(:simple) do |t|
+      t.table_format = {
+        :show_headings  => false
+      }
+      t.grouping_format = {
+        :style          => :justified,
+        :show_headings  => false
+      }
+      t.format_options = { :col_sep => ":" }
+    end
+  end
 
   def test_render_csv_table
     actual = Ruport::Renderer::Table.render_csv do |r| 
@@ -36,17 +49,6 @@ class TestRenderCSVTable < Test::Unit::TestCase
   end
      
   def test_render_with_template
-    Ruport::Formatter::Template.create(:simple) do |t|
-      t.table_format = {
-        :show_headings  => false
-      }
-      t.grouping_format = {
-        :style          => :justified,
-        :show_headings  => false
-      }
-      t.format_options = { :col_sep => ":" }
-    end
-
     formatter = Ruport::Formatter::CSV.new
     formatter.options = Ruport::Renderer::Options.new
     formatter.options.template = :simple
@@ -59,6 +61,49 @@ class TestRenderCSVTable < Test::Unit::TestCase
     
     assert_equal ":", formatter.options.format_options[:col_sep]
   end
+
+  def test_options_hashes_override_template
+    opts = nil
+    table = Table(%w[a b c])
+    table.to_csv(
+      :template => :simple,
+      :table_format => {
+        :show_headings  => true
+      },
+      :grouping_format => {
+        :style => :raw,
+        :show_headings  => true
+      }
+    ) do |r|
+      opts = r.options
+    end
+    
+    assert_equal true, opts.show_table_headers
+
+    assert_equal :raw, opts.style
+    assert_equal true, opts.show_group_headers
+  end
+
+  def test_individual_options_override_template
+    opts = nil
+    table = Table(%w[a b c])
+    table.to_csv(
+      :template => :simple,
+      :show_table_headers => true,
+      :style => :raw,
+      :show_group_headers => true,
+      :format_options => { :col_sep => ";" }
+    ) do |r|
+      opts = r.options
+    end
+    
+    assert_equal true, opts.show_table_headers
+
+    assert_equal :raw, opts.style
+    assert_equal true, opts.show_group_headers
+    
+    assert_equal ";", opts.format_options[:col_sep]
+  end
 end     
 
 class TestRenderCSVGroup < Test::Unit::TestCase

data/test/html_formatter_test.rb

@@ -3,6 +3,18 @@ require File.join(File.expand_path(File.dirname(__FILE__)), "helpers")
 
 class TestRenderHTMLTable < Test::Unit::TestCase
   
+  def setup
+    Ruport::Formatter::Template.create(:simple) do |t|
+      t.table_format = {
+        :show_headings  => false
+      }
+      t.grouping_format = {
+        :style          => :justified,
+        :show_headings  => false
+      }
+    end
+  end
+  
   def test_html_table
     a = Ruport::Formatter::HTML.new
 
@@ -34,16 +46,6 @@ class TestRenderHTMLTable < Test::Unit::TestCase
   end
   
   def test_render_with_template
-    Ruport::Formatter::Template.create(:simple) do |t|
-      t.table_format = {
-        :show_headings  => false
-      }
-      t.grouping_format = {
-        :style          => :justified,
-        :show_headings  => false
-      }
-    end
-
     formatter = Ruport::Formatter::HTML.new
     formatter.options = Ruport::Renderer::Options.new
     formatter.options.template = :simple
@@ -54,6 +56,46 @@ class TestRenderHTMLTable < Test::Unit::TestCase
     assert_equal :justified, formatter.options.style
     assert_equal false, formatter.options.show_group_headers
   end
+
+  def test_options_hashes_override_template
+    opts = nil
+    table = Table(%w[a b c])
+    table.to_html(
+      :template => :simple,
+      :table_format => {
+        :show_headings  => true
+      },
+      :grouping_format => {
+        :style => :inline,
+        :show_headings  => true
+      }
+    ) do |r|
+      opts = r.options
+    end
+    
+    assert_equal true, opts.show_table_headers
+
+    assert_equal :inline, opts.style
+    assert_equal true, opts.show_group_headers
+  end
+
+  def test_individual_options_override_template
+    opts = nil
+    table = Table(%w[a b c])
+    table.to_html(
+      :template => :simple,
+      :show_table_headers => true,
+      :style => :inline,
+      :show_group_headers => true
+    ) do |r|
+      opts = r.options
+    end
+    
+    assert_equal true, opts.show_table_headers
+
+    assert_equal :inline, opts.style
+    assert_equal true, opts.show_group_headers
+  end
 end
    
 

data/test/pdf_formatter_test.rb

@@ -2,6 +2,33 @@
 require File.join(File.expand_path(File.dirname(__FILE__)), "helpers")
 
 class TestRenderPDFTable < Test::Unit::TestCase
+  
+  def setup
+    Ruport::Formatter::Template.create(:simple) do |t|
+      t.page_format = {
+        :size   => "LETTER",
+        :layout => :landscape
+      }
+      t.text_format = {
+        :font_size => 16
+      }
+      t.table_format = {
+        :show_headings  => false
+      }
+      t.column_format = {
+        :alignment  => :center,
+        :width      => 50
+      }
+      t.heading_format = {
+        :alignment  => :right,
+        :bold       => false,
+        :title      => "Test"
+      }
+      t.grouping_format = {
+        :style => :separated
+      }
+    end
+  end
 
   def test_render_pdf_basic  
     # can't render without column names
@@ -35,31 +62,6 @@ class TestRenderPDFTable < Test::Unit::TestCase
   end
   
   def test_render_with_template
-    Ruport::Formatter::Template.create(:simple) do |t|
-      t.page_format = {
-        :size   => "LETTER",
-        :layout => :landscape
-      }
-      t.text_format = {
-        :font_size => 16
-      }
-      t.table_format = {
-        :show_headings  => false
-      }
-      t.column_format = {
-        :alignment  => :center,
-        :width      => 50
-      }
-      t.heading_format = {
-        :alignment  => :right,
-        :bold       => false,
-        :title      => "Test"
-      }
-      t.grouping_format = {
-        :style => :separated
-      }
-    end
-
     formatter = Ruport::Formatter::PDF.new
     formatter.options = Ruport::Renderer::Options.new
     formatter.options.template = :simple
@@ -87,6 +89,98 @@ class TestRenderPDFTable < Test::Unit::TestCase
     assert_equal :separated, formatter.options.style
   end
   
+  def test_options_hashes_override_template
+    opts = nil
+    table = Table(%w[a b c])
+    table.to_pdf(
+      :template => :simple,
+      :page_format => {
+        :size  => "LEGAL",
+        :layout => :portrait
+      },
+      :text_format => {
+        :font_size  => 20
+      },
+      :table_format => {
+        :show_headings  => true
+      },
+      :column_format => {
+        :alignment => :left,
+        :width => 25
+      },
+      :heading_format => {
+        :alignment => :left,
+        :bold => true,
+        :title => "Replace"
+      },
+      :grouping_format => {
+        :style  => :inline
+      }
+    ) do |r|
+      opts = r.options
+    end
+    
+    assert_equal "LEGAL", opts.paper_size
+    assert_equal :portrait, opts.paper_orientation
+
+    assert_equal 20, opts.text_format[:font_size]
+
+    assert_equal true, opts.table_format[:show_headings]
+
+    assert_equal :left, opts.table_format[:column_options][:justification]
+    assert_equal 25, opts.table_format[:column_options][:width]
+      
+    assert_equal :left,
+      opts.table_format[:column_options][:heading][:justification]
+    assert_equal true, opts.table_format[:column_options][:heading][:bold]
+    assert_equal "Replace", opts.table_format[:column_options][:heading][:title]
+
+    assert_equal :inline, opts.style
+  end
+
+  def test_individual_options_override_template
+    opts = nil
+    table = Table(%w[a b c])
+    table.to_pdf(
+      :template => :simple,
+      :paper_size => "LEGAL",
+      :paper_orientation => :portrait,
+      :text_format => { :font_size  => 20 },
+      :table_format => {
+        :show_headings  => true,
+        :column_options => {
+          :justification => :left,
+          :width => 25,
+          :heading => {
+            :justification => :left,
+            :bold => true,
+            :title => "Replace"
+          }
+        }
+      },
+      :style => :inline
+    ) do |r|
+      opts = r.options
+    end
+    
+    assert_equal "LEGAL", opts.paper_size
+    assert_equal :portrait, opts.paper_orientation
+
+    assert_equal 20, opts.text_format[:font_size]
+
+    assert_equal true, opts.table_format[:show_headings]
+
+    assert_equal :left, opts.table_format[:column_options][:justification]
+    assert_equal 25, opts.table_format[:column_options][:width]
+      
+    assert_equal :left,
+      opts.table_format[:column_options][:heading][:justification]
+    assert_equal true, opts.table_format[:column_options][:heading][:bold]
+    assert_equal "Replace", opts.table_format[:column_options][:heading][:title]
+
+    assert_equal :inline, opts.style
+  end
+
   #--------BUG TRAPS--------#
   
   # PDF::SimpleTable does not handle symbols as column names
@@ -105,7 +199,7 @@ class TestRenderPDFTable < Test::Unit::TestCase
      f.draw_table [[1,2,3],[4,5,6]].to_table(%w[a b c])  
      assert_equal({ :justification => :center }, 
                   f.options[:table_format][:column_options][:heading])      
-  end  
+  end
   
 end    
 

data/test/query_test.rb

@@ -215,7 +215,6 @@ require File.join(File.expand_path(File.dirname(__FILE__)), "helpers")
    def setup_mock_dbi(count, options={})
      sql = options[:sql] || @sql[0]
      source = options[:source] || :default
-     returns = options[:returns] || Proc.new { @datasets.shift }
      resultless = options[:resultless]
      params = options[:params] || []
      
@@ -233,9 +232,13 @@ require File.join(File.expand_path(File.dirname(__FILE__)), "helpers")
      @dbh.stubs(:sth__).returns(@sth)
      @sth.expects(:finish).with().times(count)
      unless resultless
-       @sth.stubs(:fetchable?).returns(true)
-       @sth.stubs(:column_names).returns(@columns)
-       @sth.expects(:data__).returns(returns).times(count)
+       @sth.stubs(:fetchable?).returns(true) 
+       @sth.stubs(:column_names).returns(@columns) 
+       if options[:returns]   
+         @sth.expects(:data__).returns(options[:returns]).times(count) 
+       else
+         @sth.expects(:data__).returns(*@datasets).times(count)
+       end
      else
        @sth.stubs(:fetchable?).returns(false)
        @sth.stubs(:column_names).returns([])

data/test/renderer_test.rb

@@ -77,6 +77,12 @@ class TestRenderer < Test::Unit::TestCase
        Table(%w[a b c]).to_csv(:template => :stub) do |r| 
          r.formatter.expects(:apply_template)
        end  
+     end 
+     
+     def specify_undefined_template_should_throw_sensible_error
+        assert_raises(Ruport::Formatter::TemplateNotDefined) do
+          Table(%w[a b c]).to_csv(:template => :sub)
+        end 
      end
   end
 
@@ -560,4 +566,17 @@ class TestRendererHooks < Test::Unit::TestCase
 
   end    
 
+  context "when attempting to render a format that doesn't exist" do
+
+    def specify_an_unknown_format_error_should_be_raised
+
+      assert_raises(Ruport::Renderer::UnknownFormatError) do
+        Ruport::Renderer.render_foo
+      end
+
+    end
+  end
+
+
+
 end

data/test/text_formatter_test.rb

@@ -3,6 +3,23 @@ require File.join(File.expand_path(File.dirname(__FILE__)), "helpers")
 
 class TestRenderTextTable < Test::Unit::TestCase 
   
+  def setup
+    Ruport::Formatter::Template.create(:simple) do |t|
+      t.table_format = {
+        :show_headings  => false,
+        :width          => 50,
+        :ignore_width   => true
+      }
+      t.column_format = {
+        :maximum_width  => [5,5,7],
+        :alignment => :center
+      }
+      t.grouping_format = {
+        :show_headings  => false
+      }
+    end
+  end
+
   def test_basic
 
     tf = "+-------+\n"
@@ -63,21 +80,6 @@ class TestRenderTextTable < Test::Unit::TestCase
   end
   
   def test_render_with_template
-    Ruport::Formatter::Template.create(:simple) do |t|
-      t.table_format = {
-        :show_headings  => false,
-        :width          => 50,
-        :ignore_width   => true
-      }
-      t.column_format = {
-        :maximum_width  => 5,
-        :alignment => :center
-      }
-      t.grouping_format = {
-        :show_headings  => false
-      }
-    end
-
     formatter = Ruport::Formatter::Text.new
     formatter.options = Ruport::Renderer::Options.new
     formatter.options.template = :simple
@@ -87,11 +89,67 @@ class TestRenderTextTable < Test::Unit::TestCase
     assert_equal 50, formatter.options.table_width
     assert_equal true, formatter.options.ignore_table_width
 
-    assert_equal 5, formatter.options.max_col_width
+    assert_equal [5,5,7], formatter.options.max_col_width
     assert_equal :center, formatter.options.alignment
 
     assert_equal false, formatter.options.show_group_headers
   end
+  
+  def test_options_hashes_override_template
+    opts = nil
+    table = Table(%w[a b c])
+    table.to_text(
+      :template => :simple,
+      :table_format => {
+        :show_headings  => true,
+        :width          => 25,
+        :ignore_width   => false
+      },
+      :column_format => {
+        :maximum_width  => [10,10,10],
+        :alignment => :left
+      },
+      :grouping_format => {
+        :show_headings  => true
+      }
+    ) do |r|
+      opts = r.options
+    end
+    
+    assert_equal true, opts.show_table_headers
+    assert_equal 25, opts.table_width
+    assert_equal false, opts.ignore_table_width
+
+    assert_equal [10,10,10], opts.max_col_width
+    assert_equal :left, opts.alignment
+
+    assert_equal true, opts.show_group_headers
+  end
+
+  def test_individual_options_override_template
+    opts = nil
+    table = Table(%w[a b c])
+    table.to_text(
+      :template => :simple,
+      :show_table_headers => true,
+      :table_width => 75,
+      :ignore_table_width => false,
+      :max_col_width => [4,4,4],
+      :alignment => :left,
+      :show_group_headers => true
+    ) do |r|
+      opts = r.options
+    end
+    
+    assert_equal true, opts.show_table_headers
+    assert_equal 75, opts.table_width
+    assert_equal false, opts.ignore_table_width
+
+    assert_equal [4,4,4], opts.max_col_width
+    assert_equal :left, opts.alignment
+
+    assert_equal true, opts.show_group_headers
+  end
                                              
   # -- BUG TRAPS ------------------------------
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: ruport
 version: !ruby/object:Gem::Version 
-  version: 1.2.2
-date: 2007-10-29 00:00:00 -04:00
+  version: 1.2.3
+date: 2007-11-24 00:00:00 -05:00
 summary: A generalized Ruby report generation and templating engine.
 require_paths: 
 - lib