ruport 0.7.1 → 0.7.2

data/lib/ruport/renderer.rb

@@ -33,7 +33,8 @@ class Ruport::Renderer
       plugin.send something if plugin.respond_to? something
     end
   end
-  # allows you to register a format with the renderer.
+
+  # Allows you to register a format with the renderer.
   #
   # example:
   #
@@ -44,9 +45,11 @@ class Ruport::Renderer
   #     SomeRenderer.add_format self, :my_plugin
   #
   #   end
+  #
   def self.add_format(format,name=nil)
     return formats[name] = format if name
 
+    # NOTE: MEANT FOR INTERNAL USE
     add_core_format(format)   
  end
 
@@ -58,6 +61,7 @@ class Ruport::Renderer
 
   # same as Renderer#layout, but can be used to specify a default layout object
   # for the entire class.  
+  #
   def self.layout
     @layout ||= Ruport::Layout::Component.new
     yield(@layout) if block_given?
@@ -72,6 +76,7 @@ class Ruport::Renderer
   # The run() method is then called on the renderer method.
   #
   # Finally, the value of the plugin's output accessor is returned
+  #
   def self.render(format,&block)
     rend = build format, &block
     rend.run
@@ -84,6 +89,7 @@ class Ruport::Renderer
   # yielded.  
   #
   # Returns the renderer instance.
+  #
   def self.build(format)
     rend = self.new
 
@@ -108,6 +114,7 @@ class Ruport::Renderer
   end
 
   # sets +data+ attribute on both the renderer and any active plugin
+  #
   def data=(val)
     @data = val.dup
     plugin.data = @data if plugin
@@ -115,6 +122,7 @@ class Ruport::Renderer
 
   # General purpose openstruct which is shared with the current formatting
   # plugin.
+  #
   def options
     yield(plugin.options) if block_given?
     plugin.options
@@ -127,6 +135,7 @@ class Ruport::Renderer
   #
   # when a block is given without block variables, instance_evals the block
   # within the context of the plugin
+  #
   def plugin(&block)
     if block.nil?
       return @plugin 
@@ -150,6 +159,7 @@ class Ruport::Renderer
 
   # tries to autoload and register a format which is part of the Ruport::Format
   # module.  For internal use only.
+  #
   def self.add_core_format(format)
     try_require(format)
     
@@ -160,12 +170,14 @@ class Ruport::Renderer
   end
 
   # internal shortcut for format registering
+  #
   def self.add_formats(*formats)
     formats.each { |f| add_format f }
   end
 
   # Trys to autoload a given format,
   # silently fails
+  #
   def self.try_require(format)
     begin
       require "ruport/format/#{format}"  
@@ -175,12 +187,14 @@ class Ruport::Renderer
   end
 
   # selects a plugin for use by format name
+  #
   def use_plugin(format)
     self.plugin = self.class.formats[format].new
   end
 
   # provides a shortcut to render() to allow
   # render(:csv) to become render_csv
+  #
   def self.method_missing(id,*args,&block)
     id.to_s =~ /^render_(.*)/
     $1 ? render($1.to_sym,&block) : super

data/lib/ruport/report.rb

@@ -63,16 +63,9 @@ module Ruport
   #  } 
   #
   # 
-  # This class can also be used to run templates and process text filters.
-  #
-  # See the examples in the documentation below to see how to use these
-  # features (namely Report#process_text , Report#text_processor, and
-  # Report#eval_template).
-  #
   class Report   
     extend Forwardable
     
-    # 
     # When initializing a report, you can provide a default mailer and source by
     # giving a name of a valid source or mailer you've defined via
     # Ruport::Config.
@@ -93,7 +86,6 @@ module Ruport
     # By default, this file will be used by Report#write.
     attr_accessor :file
 
-    #
     # This attribute will get the results of Report#generate when the report is
     # run.
     #
@@ -114,9 +106,9 @@ module Ruport
     #   # will return the value of the last statement, "select * from foo"
     #   result = query "insert into foo values(1,2); select * from foo"
     # 
-    # You can iterate by row or return the entire set:
+    # You can iterate by row:
     #  
-    #   query("select * from foo", :yield_type => :by_row) { |r|
+    #   query("select * from foo") { |r|
     #     #do something with the rows here
     #   }
     # 
@@ -165,7 +157,6 @@ module Ruport
       File.open(my_file,"w") { |f| f << my_results }
     end
 
-    #
     # Like Report#write, but will append to a file rather than overwrite it if
     # the file already exists.
     #
@@ -182,7 +173,6 @@ module Ruport
       self.class.run(options,&block)
     end
 
-    #
     # Loads a CSV in from  a file.
     #
     # Example:
@@ -202,7 +192,6 @@ module Ruport
       end
     end
 
-    #
     # Executes an erb template.  If a filename is given which matches the
     # pattern /\.r\w+$/ (eg foo.rhtml, bar.rtxt, etc), 
     # it will be loaded and evaluated.  Otherwise, the string will be processed
@@ -234,13 +223,11 @@ module Ruport
       RedCloth.new(s).to_html
     end
     
-    #
     # Allows logging and other fun stuff. 
     # See also Ruport.log
     #
     def log(*args); Ruport.log(*args) end
    
-    #
     # Creates a new Mailer and sets the <tt>to</tt> attribute to the addresses
     # specified. Yields a Mailer object, which can be modified before delivery.
     #
@@ -256,7 +243,6 @@ module Ruport
     
     class << self
 
-      #
       # Defines an instance method which will be run before the
       # <tt>generate</tt> method when Ruport.run is executed.
       #
@@ -264,7 +250,6 @@ module Ruport
       #
       def prepare(&block); define_method(:prepare,&block) end
       
-      #
       # Defines an instance method which will be executed by Report.run.
       #
       # The return value of this method is assigned to the <tt>results</tt>
@@ -272,13 +257,13 @@ module Ruport
       #
       def generate(&block); define_method(:generate,&block) end
       
-      #
       # Defines an instance method which will be executed after the object is
       # yielded in Report.run.
       #
       def cleanup(&block); define_method(:cleanup,&block) end
+
+      private :prepare, :generate, :cleanup
       
-      #
       # Runs the reports specified.  If no reports are specified, then it
       # creates a new instance via <tt>self.new</tt>.
       #
@@ -290,9 +275,7 @@ module Ruport
       #
       # This method will return the contents of Report#results, as a single
       # value for single reports, and an array of outputs for multiple reports.
-
-      private :prepare, :generate, :cleanup
-
+      #
       def run(options={})
         options[:reports] ||= [self.new]
 

data/test/test_mailer.rb

@@ -2,6 +2,14 @@ require "test/unit"
 require "ruport"
 begin; require "rubygems"; rescue LoadError; nil end
 
+begin
+  require 'mocha'
+  require 'stubba'
+  require 'net/smtp'
+rescue LoadError
+  $stderr.puts "Warning: Mocha not found -- skipping some Mailer tests"
+end
+
 class TestMailer < Test::Unit::TestCase
 
   def setup
@@ -40,7 +48,12 @@ class TestMailer < Test::Unit::TestCase
   def test_constructor_with_mailer_label
     assert_mailer_equal @other_opts, @other_mailer
   end
-  
+
+  def test_constructor_without_mailer
+    Ruport::Config.mailers[:default] = nil
+    assert_raise(RuntimeError) { Ruport::Mailer.new }
+  end
+ 
   def test_select_mailer
     mailer = Ruport::Mailer.new :default
     assert_mailer_equal @default_opts, mailer
@@ -79,30 +92,79 @@ class TestMailer < Test::Unit::TestCase
     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 }
+  def test_send_mail_with_default
+    return unless Object.const_defined? :Mocha
+    setup_mock_mailer(1)
+    assert_equal "250 ok",
+      @default_mailer.deliver(:to      => "clyde@example.com",
+                              :from    => "sue@example.com",
+                              :subject => "Hello",
+                              :text    => "This is a test.")
+  end
+
+  def test_send_mail_with_other
+    return unless Object.const_defined? :Mocha
+    setup_mock_mailer(1, @other_mailer)
+    assert_equal "250 ok",
+      @other_mailer.deliver(:to      => "sue@example.com",
+                            :from    => "clyde@example.com",
+                            :subject => "Hello",
+                            :text    => "This is a test.")
+  end
+
+  def test_send_mail_without_to
+    return unless Object.const_defined? :Mocha
+    setup_mock_mailer(1)
+    assert_raise(Net::SMTPSyntaxError) {
+      @default_mailer.deliver(:from    => "sue@example.com",
+                              :subject => "Hello",
+                              :text    => "This is a test.")
+    }
+  end
+
+  def test_send_html_mail
+    return unless Object.const_defined? :Mocha
+    setup_mock_mailer(1)
+    assert_equal "250 ok",
+      @default_mailer.deliver(:to      => "clyde@example.com",
+                              :from    => "sue@example.com",
+                              :subject => "Hello",
+                              :html    => "<p>This is a test.</p>")
+  end
+
+  def test_send_mail_with_attachment
+    return unless Object.const_defined? :Mocha
+    setup_mock_mailer(1)
+    @default_mailer.attach 'test/samples/data.csv'
+    assert_equal "250 ok",
+      @default_mailer.deliver(:to      => "clyde@example.com",
+                              :from    => "sue@example.com",
+                              :subject => "Hello",
+                              :text    => "This is a test.")
   end
   
+  private
+  
+  def setup_mock_mailer(count, mailer=@default_mailer)
+    host      = mailer.instance_variable_get(:@host)
+    port      = mailer.instance_variable_get(:@port)
+    user      = mailer.instance_variable_get(:@user)
+    password  = mailer.instance_variable_get(:@password)
+    auth      = mailer.instance_variable_get(:@auth)
+    
+    @smtp     = mock('smtp')
+    
+    Net::SMTP.expects(:start).
+      with(host,port,host,user,password,auth).
+      yields(@smtp).
+      returns("250 ok").times(count)
+    @smtp.stubs(:send_message).
+      with {|*params| !params[2].nil? }.
+      returns("250 ok")
+    @smtp.stubs(:send_message).
+      with {|*params| params[2].nil? }.
+      raises(Net::SMTPSyntaxError)
+  end
+
 end
 

data/test/test_report.rb

@@ -6,12 +6,22 @@
 require "test/unit"
 require "ruport"
 begin; require "rubygems"; rescue LoadError; nil; end
+
+begin
+  require 'mocha'
+  require 'stubba'
+  require 'net/smtp'
+rescue LoadError
+  $stderr.puts "Warning: Mocha not found -- skipping some Report tests"
+end
+
 class TestReport < Test::Unit::TestCase
   include Ruport
 
   def setup
     @report = Report.new
-    Ruport::Config.source :default, :dsn => "ruport:test", :user => "foo", :password => "bar" 
+    Ruport::Config.source :default, :dsn => "ruport:test", 
+                                    :user => "foo", :password => "bar" 
     @query1 = Ruport::Query.new "select * from foo", :cache_enabled => true 
     @query1.cached_data = [[1,2,3],[4,5,6],[7,8,9]].to_table(%w[a b c]) 
   end
@@ -106,5 +116,66 @@ class TestReport < Test::Unit::TestCase
     assert_equal ["hello dolly", "hello dolly"],
       rep_klass.run(:reports => [rep_klass.new,rep_klass.new])
   end
+  
+  def test_send_to
+     return unless Object.const_defined? :Mocha
+     setup_mock_mailer
+     @report = Report.new
+     assert_equal "250 ok", @report.send_to("clyde@example.com") { |mail|
+       mail.subject = "Test Report"
+       mail.text = "Test"
+     }
+   end
+ 
+   def test_write_to_file
+     return unless Object.const_defined? :Mocha
+     setup_mock_file
+     @report = Report.new
+     assert @report.write("foo.csv")
+   end
+ 
+   def test_append_to_file
+     return unless Object.const_defined? :Mocha
+     setup_mock_file
+     @report = Report.new
+     assert @report.append("foo.csv")
+   end
+ 
+   def test_load_csv
+     expected = [%w[a b c],['d', nil, 'e']].to_table(%w[col1 col2 col3])
+ 
+     @report = Report.new
+     table = @report.load_csv("test/samples/data.csv")
+ 
+     assert_equal expected, table
+   end
+ 
+   def test_load_csv_as_array
+     expected = [%w[a b c],['d', nil, 'e']]
+ 
+     @report = Report.new
+     array = @report.load_csv("test/samples/data.csv", :as => :array)
+ 
+     assert_equal expected, array
+   end
+ 
+   private
+ 
+   def setup_mock_mailer
+     @smtp     = mock('smtp')
+ 
+     Net::SMTP.expects(:start).
+       yields(@smtp).
+       returns("250 ok").at_least_once
+     @smtp.stubs(:send_message).
+       returns("250 ok")
+   end
+ 
+   def setup_mock_file
+     @file = mock("file")
+ 
+     File.expects(:open).yields(@file).returns(@file).at_least_once
+     @file.expects(:<<).returns(@file).at_least_once
+   end
 
 end

data/test/test_table.rb

@@ -294,6 +294,21 @@ class TestTable < Test::Unit::TestCase
 
   end
 
+
+ #Ticket #142          
+  def test_ensure_constructor_dups_record_tags
+    a = [[1,2,3],[4,5,6],[7,8,9]].to_table(%w[a b c])
+    b = a.dup    
+    
+    a[0].tag :foo
+    assert_equal [], b[0].tags
+    assert_equal [:foo],a[0].tags
+    
+    b[1].tag :bar
+    assert_equal [], a[1].tags
+    assert_equal [:bar], b[1].tags
+  end        
+
   def test_setting_column_names_changes_record_attributes
     table = Ruport::Data::Table.new :column_names => %w[a b c], 
       :data => [[1,2,3],[4,5,6]]