ruport 0.4.23 → 0.4.99

data/lib/ruport/report/invoice.rb

@@ -1,10 +1,26 @@
 module Ruport
   class Report
     module Invoice
+      
+      # Returns a Format::Engine::Invoice object
+      #
+      # If a block is given, it is possible to customize this object before it
+      # is returned
+      #
+      # Example:
+      #
+      #   inv = build_invoice do |i|
+      #     i.company_info  = "Foo Inc.\n42 Front Street\nNew Haven CT"
+      #     i.customer_info = "Joe User\njoe@test.com"
+      #     i.data = [["Aspirin","$2.00"]].to_table(%w[item cost])
+      #   end
       def build_invoice
         a = Ruport::Format.invoice_object(:plugin => :pdf)
         yield(a); return a
       end
+
+      # Takes a block and calls build_invoice then calls render on the resulting
+      # Format::Engine::Invoice object
       def render_invoice(&block)
         build_invoice(&block).render
       end

data/lib/ruport/system_extensions.rb

@@ -9,6 +9,9 @@
 # - 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
 #
@@ -32,18 +35,6 @@ module Ruport
     begin
       require "Win32API"       # See if we're on Windows.
 
-      CHARACTER_MODE = "Win32API"    # For Debugging purposes only.
-
-      #
-      # Windows savvy getc().
-      # 
-      # *WARNING*:  This method ignores <tt>input</tt> and reads one
-      # character from +STDIN+!
-      # 
-      def get_character( input = STDIN )
-        Win32API.new("crtdll", "_getch", [ ], "L").Call
-      end
-
       # A Windows savvy method to fetch the console columns, and rows.
       def terminal_size
         m_GetStdHandle               = Win32API.new( 'kernel32',
@@ -64,49 +55,6 @@ module Ruport
         return right - left + 1, bottom - top + 1
       end
     rescue LoadError             # If we're not on Windows try...
-      begin
-        require "termios"    # Unix, first choice.
-
-        CHARACTER_MODE = "termios"    # For Debugging purposes only.
-
-        #
-        # Unix savvy getc().  (First choice.)
-        # 
-        # *WARNING*:  This method requires the "termios" library!
-        # 
-        def get_character( input = STDIN )
-          old_settings = Termios.getattr(input)
-
-          new_settings         =  old_settings.dup
-          new_settings.c_lflag &= ~(Termios::ECHO | Termios::ICANON)
-
-          begin
-            Termios.setattr(input, Termios::TCSANOW, new_settings)
-            input.getc
-          ensure
-            Termios.setattr(input, Termios::TCSANOW, old_settings)
-          end
-        end
-      rescue LoadError         # If our first choice fails, default.
-        CHARACTER_MODE = "stty"    # For Debugging purposes only.
-
-        #
-        # Unix savvy getc().  (Second choice.)
-        # 
-        # *WARNING*:  This method requires the external "stty" program!
-        # 
-        def get_character( input = STDIN )
-          state = `stty -g`
-
-          begin
-            system "stty raw -echo cbreak"
-            input.getc
-          ensure
-            system "stty #{state}"
-          end
-        end
-      end
-      
       # A Unix savvy method to fetch the console columns, and rows.
       def terminal_size
        `stty size`.split.map { |x| x.to_i }.reverse

data/test/{tc_format.rb → test_format.rb}

@@ -1,6 +1,7 @@
 require "ruport"
 require "test/unit"
 
+require "rubygems" rescue LoadError nil
 class TestFormat < Test::Unit::TestCase
  
   def setup

data/test/{tc_format_engine.rb → test_format_engine.rb}

@@ -1,5 +1,5 @@
-require 'rubygems' rescue LoadError nil
 require 'ruport'
+require 'rubygems' rescue LoadError nil
 require 'test/unit'
 
 class MockPlugin < Ruport::Format::Plugin
@@ -75,6 +75,15 @@ class TestTabularFormatEngine < Test::Unit::TestCase
     assert_equal "#{@engine.data}", @engine.render 
   end
 
+  # test that attempting to render using an invalid plugin returns an exception
+  # with a useful message
+  def test_render_with_invalid_plugin
+    assert_raises(InvalidPluginError) {
+      Format.table(:plugin => :monkeys, 
+                   :data => [[1,2,3],[4,5,6],[7,8,9]].to_table(%w[a b c]))
+    }
+  end
+  
   def test_simple_interface
     expected = "#{[[1,2],[3,4]]}"
     actual = Format.table(:plugin => :mock, :data => [[1,2],[3,4]]) 
@@ -138,7 +147,7 @@ class TestTabularFormatEngine < Test::Unit::TestCase
     assert_equal( [[1,2,3],[nil,2,4],[nil,3,7],
                    [2,1,9],[nil,2,3],[nil,2,9]], @engine.data)
 
-    data = Data::Table.new :column_names => %w[name date service amount]
+    data = Ruport::Data::Table.new :column_names => %w[name date service amount]
     data << [ "Greg Gibson", "1/1/2000",  "Prophy",  "100.00" ] <<
             [ "Greg Gibson", "1/1/2000",  "Filling", "100.00" ] <<
             [ "Greg Gibson", "1/12/2000", "Prophy",  "100.00" ] <<
@@ -163,6 +172,9 @@ class TestTabularFormatEngine < Test::Unit::TestCase
 end
 
 class TestDocumentFormatEngine < Test::Unit::TestCase
+  
+  include Ruport
+  
   def setup
     @engine = Format::Engine::Document.dup
   end

data/test/test_graph.rb

@@ -0,0 +1,101 @@
+require "ruport"
+require 'rubygems' rescue LoadError nil
+require "test/unit"
+
+class TestGraph < Test::Unit::TestCase
+
+  def setup
+    @data = [[1,2,3,2],[3,4,5,6]].to_table(%w[a b c d])
+    @data_mismatched_headings = [[3,2],[3,4]].to_table(%w[a b c])
+    @data_float = [[1.3,2],[3.28322,4]].to_table(%w[a b])
+    @data_not_numbers = [["d",:sdfs,"not a number","1"],[3,4,5,6]].to_table(%w[a b c d])
+  end
+
+  # basic test to ensure bar charts render
+  def test_bar
+    graph = Ruport::Format.graph_object :plugin => :svg, :data => @data
+    graph.options = {:graph_style => :bar}
+    output = graph.render
+
+    assert_not_equal nil, output
+  end
+
+  # basic test to ensure horizontal pie charts render
+  def test_bar_horizontal
+    graph = Ruport::Format.graph_object :plugin => :svg, :data => @data
+    graph.options = {:graph_style => :bar_horizontal}
+    output = graph.render
+
+    assert_not_equal nil, output
+  end
+  
+  # basic test to ensure line charts render
+  def test_line
+    graph = Ruport::Format.graph_object :plugin => :svg, :data => @data
+    graph.options = {:graph_style => :line}
+    output = graph.render
+
+    assert_not_equal nil, output
+  end
+  
+  # basic test to ensure pie charts render
+  def test_pie
+    graph = Ruport::Format.graph_object :plugin => :svg, :data => @data
+    graph.options = {:graph_style => :pie}
+    output = graph.render
+
+    assert_not_equal nil, output
+  end
+ 
+  # ensure an exception is raised if the user doesn't name every column
+  def test_mismatched_headings
+    graph = Ruport::Format.graph_object :plugin => :svg, :data => @data_mismatched_headings
+    graph.options = {:graph_style => :line}
+
+    assert_raises(ArgumentError) {
+      output = graph.render
+    }
+  end
+  
+  # test to ensure floats can be graphed
+  def test_floats
+    graph = Ruport::Format.graph_object :plugin => :svg, :data => @data_float
+    graph.options = {:graph_style => :line}
+    output = graph.render
+
+    assert_not_equal nil, output
+  end
+  
+  # ensure an exception is raised if non numeric data is graphed
+  def test_not_numbers
+    graph = Ruport::Format.graph_object :plugin => :svg, :data => @data_not_numbers
+    graph.options = {:graph_style => :line}
+    
+    assert_raises(ArgumentError) {
+      output = graph.render
+    }
+  end
+
+  # ensure an exception is raised if user tries to render a graph without setting any options
+  def test_no_options
+    graph = Ruport::Format.graph_object :plugin => :svg, :data => @data
+    
+    assert_raises(RuntimeError) {
+      output = graph.render
+    }
+
+  end
+  
+  # test to make sure user requested options are applied to the resulting graph
+  def test_options_applied_to_rendered_graph
+    graph = Ruport::Format.graph_object :plugin => :svg, :data => @data
+    graph.options = {:graph_style => :line, :graph_title => 'Test', :show_graph_title => true, :no_css => true}
+    output = graph.render
+    
+    # ensure the requested graph title is included in the SVG output. If that's there, we can
+    # assume the rest are as well
+    assert_not_equal nil, output[/class='mainTitle'/]
+
+  end
+
+end

data/test/{tc_invoice.rb → test_invoice.rb}

@@ -1,3 +1,4 @@
+require 'ruport'
 require 'rubygems' rescue LoadError nil
 require "test/unit"
 
@@ -6,8 +7,13 @@ class SampleInvoiceReport < Ruport::Report
 end
 
 class TestInvoice < Test::Unit::TestCase
-  
+ 
   def test_basic
+    begin
+      require "pdf/writer"
+    rescue LoadError
+      warn "skipping pdf test"; return
+    end
     inv = SampleInvoiceReport.build_invoice do |i|
       i.company_info = "Foo Inc.\n42 Bar Street\nBaz, CT\n"
       i.customer_info = "Gregory Brown\ngregory.t.brown@gmail.com"

data/test/test_mailer.rb

@@ -0,0 +1,108 @@
+require "test/unit"
+require "ruport"
+begin; require "rubygems"; rescue LoadError; nil end
+
+class TestMailer < Test::Unit::TestCase
+
+  def setup
+    @default_opts = {
+      :host => "mail.example.com", 
+      :address => "sue@example.com", 
+      :user => "inky",
+      :password => "chunky"
+    }
+
+    @other_opts = {
+      :host => "moremail.example.com",
+      :address => "clyde@example.com",
+      :user => "blinky",
+      :password => "bacon"
+    }
+
+    Ruport::Config.mailer :default, @default_opts
+    Ruport::Config.mailer :other, @other_opts
+
+    @default_mailer = Ruport::Mailer.new
+    @other_mailer = Ruport::Mailer.new :other 
+  end
+    
+  def assert_mailer_equal(expected, mailer)
+    assert_equal expected[:host], mailer.instance_variable_get(:@host)
+    assert_equal expected[:address], mailer.instance_variable_get(:@address)
+    assert_equal expected[:user], mailer.instance_variable_get(:@user)
+    assert_equal expected[:password], mailer.instance_variable_get(:@password)
+  end
+  
+  def test_default_constructor    
+    assert_mailer_equal @default_opts, @default_mailer
+  end
+  
+  def test_constructor_with_mailer_label
+    assert_mailer_equal @other_opts, @other_mailer
+  end
+  
+  def test_select_mailer
+    mailer = Ruport::Mailer.new :default
+    assert_mailer_equal @default_opts, mailer
+
+    mailer.send(:select_mailer, :other)
+    assert_mailer_equal @other_opts, mailer
+  end
+
+  def test_to
+    @default_mailer.instance_eval "@mail.to = ['foo@bar.com']"
+    assert_equal ['foo@bar.com'], @default_mailer.to
+  end
+
+  def test_to_equals
+    @default_mailer.to = ['foo@bar.com']
+    assert_equal ['foo@bar.com'], @default_mailer.to    
+  end
+
+  def test_from
+    @default_mailer.instance_eval "@mail.from = ['foo@bar.com']"
+    assert_equal ['foo@bar.com'], @default_mailer.from
+  end
+
+  def test_from_equals
+    @default_mailer.from = ['foo@bar.com']
+    assert_equal ['foo@bar.com'], @default_mailer.from
+  end
+
+  def test_subject
+    @default_mailer.instance_eval "@mail.subject = ['RuportDay!']"
+    assert_equal ['RuportDay!'], @default_mailer.subject
+  end
+
+  def test_subject_equals
+    @default_mailer.subject = ['RuportDay!']
+    assert_equal ['RuportDay!'], @default_mailer.subject
+  end
+
+  # def test_html
+ #    @default_mailer.instance_eval "@mail.html = 'RuportDay!'"
+ #    assert_equal 'RuportDay!', @default_mailer.html
+ #  end
+ # 
+ #  def test_html_equals
+ #    @default_mailer.html = 'RuportDay!'
+ #    assert_equal 'RuportDay!', @default_mailer.html
+ #  end
+ # 
+ #  def test_text
+ #    @default_mailer.instance_eval "@mail.text = 'RuportDay!'"
+ #    assert_equal 'RuportDay!', @default_mailer.text
+ #  end
+ # 
+ #  def test_text_equals
+ #    @default_mailer.text = 'RuportDay!'
+ #    assert_equal 'RuportDay!', @default_mailer.text
+ #  end
+
+  def test_no_default
+    Ruport::Config.mailers[:default] = nil
+    assert_raise(RuntimeError){ Ruport::Mailer.new }
+  end
+  
+end
+

data/test/test_meta_tools.rb

@@ -0,0 +1,14 @@
+require "test/unit"
+require "ruport"
+
+class A; extend Ruport::MetaTools; end
+
+class TestMetaTools < Test::Unit::TestCase
+  
+  def test_action
+    assert_nothing_raised { A.action(:foo) { |x| x + 1 } }
+    assert_equal 4, A.foo(3)
+    assert_raise(ActionAlreadyDefinedError) { A.action(:foo) { } }
+  end
+
+end

data/test/{tc_plugin.rb → test_plugin.rb}

@@ -1,6 +1,6 @@
 require "test/unit"
 require "ruport"
-
+require "rubygems" rescue LoadError nil
 
 include Ruport
 
@@ -49,6 +49,11 @@ end
 class PDFPluginTest < Test::Unit::TestCase
 
   def test_ensure_fails_on_array
+    begin
+      require "pdf/writer" 
+    rescue LoadError 
+      warn "skipping pdf test"; return
+    end
     a = Format.table_object :plugin => :pdf, :data => [[1,2],[3,4]]
     assert_raise(RuntimeError) { a.render }
     
@@ -61,6 +66,12 @@ class PDFPluginTest < Test::Unit::TestCase
   end
 
   def test_hooks
+    begin
+      require "pdf/writer" 
+    rescue LoadError 
+      warn "skipping pdf test"; return
+    end
+    a = Format.table_object :plugin => :pdf, :data => [[1,2],[3,4]]
     a = Format.table_object :plugin => :pdf, 
           :data   => [[1,2],[3,4]].to_table(:column_names => %w[a b])
     y = 0

data/test/{tc_record.rb → test_record.rb}

@@ -135,6 +135,15 @@ class RecordTest < Test::Unit::TestCase
     @record.reorder! 3,1,2
     assert_equal [3,4,2], @record.data
     assert_equal %w[c d b], @record.attributes
+
+    r.reorder! %w[a b c]
+    assert_equal [1,2,3], r.data
+    assert_equal %w[a b c], r.attributes
+
+    assert_raise(ArgumentError) { r.reorder "foo" }
+    assert_raise(ArgumentError) { r.reorder 0,5 }
+    assert_nothing_raised { r.reorder 0 }
+    assert_nothing_raised { r.reorder "a","b" }
   end
 
   def test_dup