ruport 0.4.17 → 0.4.19

data/lib/ruport/format/engine.rb

@@ -1,29 +1,30 @@
 module Ruport
   class Format::Engine
     require "forwardable"
+    require "enumerator"
     class << self
 
       include Enumerable
       include MetaTools
       extend Forwardable
 
-      attr_accessor :engine_klasses
+      attr_accessor :engine_classes
       attr_reader :plugin 
       attr_reader :data
-      attr_accessor :klass_binding
+      attr_accessor :class_binding
       attr_reader :options
       
       def_delegator :@data, :each
-      private :attribute, :attributes, :singleton, :action
+      private :attribute, :attributes, :singleton_class, :action
 
       def renderer(&block)
         block = lambda { data } unless block_given?
-        singleton.send(:define_method, :render,&block)
+        singleton_class.send(:define_method, :render,&block)
       end
       
       def alias_engine(klass,name)
-        Format::Engine.engine_klasses ||= {}
-        Format::Engine.engine_klasses[name] = klass
+        Format::Engine.engine_classes ||= {}
+        Format::Engine.engine_classes[name] = klass
       end
 
       def data=(data)
@@ -49,7 +50,7 @@ module Ruport
       
       def apply_erb
        active_plugin.data = 
-         ERB.new(active_plugin.data).result(klass_binding || binding)
+         ERB.new(active_plugin.data).result(class_binding || binding)
       end
  
       def render
@@ -57,7 +58,7 @@ module Ruport
         raise "No data provided" unless data
         active_plugin.data = data.dup
         if active_plugin.respond_to? :init_plugin_helper
-          active_plugin.init_plugin_helper(self)
+           active_plugin.init_plugin_helper(self)
         end
       end
 
@@ -66,7 +67,7 @@ module Ruport
       end
       
       def accept_format_plugin(klass) 
-        format_plugins[klass.format_name] = klass
+        format_plugins[klass.plugin_name] = klass
       end
 
       private  
@@ -83,12 +84,14 @@ module Ruport
         format_plugins.values
       end 
       
-      def method_missing(id)
+      def method_missing(id,*args)
         super unless active_plugin.respond_to?("#{id}_helper")
         return active_plugin.send("#{id}_helper",self)
       end
 
     end
+    
+    private_class_method :new
   end
   
   class Format::Engine::Table < Format::Engine      
@@ -99,7 +102,7 @@ module Ruport
         build_field_names if (data.respond_to?(:column_names) && 
                               data.column_names && show_field_names)
         a = active_plugin.render_table
-      end
+     end
 
     class << self
 
@@ -112,12 +115,12 @@ module Ruport
       end
 
       def prune(limit=data[0].length)
-        (0...limit).each do |field|
+        limit.times do |field|
           last = ""
-          data.each_with_index { |e,i|
-            next if i.zero? || field.nonzero? && data[i][field-1] 
-            last = data[i-1][field] if data[i-1][field]
-            data[i][field] = nil if e[field] == last
+          data.each_cons(2) { |l,e|
+            next if field.nonzero? && e[field-1] 
+            last = l[field] if l[field]
+            e[field] = nil if e[field] == last
           }
         end
       end

data/lib/ruport/format/open_node.rb

@@ -11,12 +11,12 @@ module Ruport
         @my_name          = my_name
         super(options)
         self.name = name
-        self.send(@my_children_name) || 
-        self.send("#{@my_children_name}=".to_sym,{})
+        send(@my_children_name) || 
+        send("#{@my_children_name}=".to_sym,{})
       end
       
-      def each &p
-        self.send(@my_children_name).values.each(&p)
+     def each(&p)
+        send(@my_children_name).values.each(&p)
       end
       
       def add_child(klass,name,options={})

data/lib/ruport/format/plugin.rb

@@ -9,33 +9,33 @@ module Ruport
       include MetaTools
 
       def helper(name,&block)
-        singleton.send( :define_method, "#{name}_helper", &block )
+        singleton_class.send( :define_method, "#{name}_helper", &block )
       end
 
-      private :singleton, :attribute, :attributes, :action
+      private :singleton_class, :attribute, :attributes, :action
      
       def plugin_name(name=nil); @name ||= name; end
       
-      def format_name
-        pattern = /Ruport::Format|Plugin/
-        @name ||= 
-         self.name.gsub(pattern,"").downcase.delete(":").to_sym
-      end
+      #def format_name
+      #  pattern = /Ruport::Format|Plugin/
+      #  @name ||= 
+      #   self.name.gsub(pattern,"").downcase.delete(":").to_sym
+      #end
       
       def renderer(render_type,&block)
         m = "render_#{render_type}".to_sym
-        block = lambda { data } unless block_given?
-        singleton.send(:define_method, m, &block)
+        block ||= lambda { data } 
+        singleton_class.send(:define_method, m, &block)
       end
 
       def format_field_names(&block)
-        singleton.send( :define_method, :build_field_names, &block)
+        singleton_class.send( :define_method, :build_field_names, &block)
       end
 
       def register_on(klass)
         
         if klass.kind_of? Symbol
-          klass = Format::Engine.engine_klasses[klass]
+          klass = Format::Engine.engine_classes[klass]
         end
         
         klass.accept_format_plugin(self)
@@ -65,7 +65,8 @@ module Ruport
         rendered_field_names +
         FasterCSV.generate { |csv| data.each { |r| csv << r } }
       end
-
+      
+      plugin_name :csv
       register_on :table_engine
     end
 
@@ -91,9 +92,9 @@ module Ruport
 
         width = self.right_margin || SystemExtensions.terminal_width
         
-        a.split("\n").each { |r|
-           r.gsub!(/\A.{#{width},}/) { |m| m[0,width-2] += ">>" }
-        }.join("\n") << "\n"
+        a.to_a.each { |r|
+           r.gsub!(/\A.{#{width+1},}/) { |m| m[0,width-2] + ">>" }
+        }.join
       end
       
       format_field_names do
@@ -129,7 +130,7 @@ module Ruport
       end
 
       attribute :right_margin
-
+      plugin_name :text
       register_on :table_engine
       register_on :document_engine
     end
@@ -154,7 +155,8 @@ module Ruport
       end
 
       format_field_names { data.column_names }
-
+      
+      plugin_name :pdf
       register_on :table_engine
     end
 
@@ -176,6 +178,7 @@ module Ruport
         s = "|_." + data.column_names.join(" |_.") + "|\n"
       end
 
+      plugin_name :html
       register_on :table_engine
       register_on :document_engine
       

data/lib/ruport/meta_tools.rb

@@ -1,19 +1,42 @@
 module Ruport
+  # This module provides a few tools for doing some manipulations of the
+  # eigenclass on an object.  These are used in the implementation of Ruport's
+  # formatting system, and might be helpful for other things.
+  #
   module MetaTools
-    def singleton; (class << self; self; end); end
-
+    # allows you to define an attribute accessor on the singleton_class.
+    #
+    # Example:
+    # 
+    #  class A
+    #     class << self; include MetaTools; end
+    #
+    #     attribute :foo
+    #  end
+    #
+    #  A.foo #=> nil
+    #  A.foo = 7 #=> 7 
     def attribute(sym,value = nil)
-      singleton.send(:attr_accessor, sym )
+      singleton_class.send(:attr_accessor, sym )
       self.send("#{sym}=",value)
     end
 
+    # same as accessor, but takes an array of attributes
+    #
+    # e.g. attributes [:foo,:bar,:baz]
     def attributes(syms)
       syms.each { |s| attribute s }
     end
 
     def action(name,&block)
-      singleton.send(:define_method, name, &block)
+      singleton_class.send(:define_method, name, &block)
     end
   end
 end
 
+class Module
+
+    # provides the singleton_class object
+    def singleton_class; (class << self; self; end); end
+
+end

data/lib/ruport/query.rb

@@ -99,7 +99,7 @@ module Ruport
     
     # Standard each iterator, iterates through result set row by row.
     def each(&action) 
-      Ruport::complain(
+      Ruport.log(
         "no block given!", :status => :fatal,
         :level => :log_only, :exception => LocalJumpError 
       ) unless action
@@ -115,7 +115,7 @@ module Ruport
     
     # clears the contents of the cache
     def clear_cache
-      @CAched_data = nil
+      @cached_data = nil
     end
 
     # clears the contents of the cache and then runs the query, filling the
@@ -179,19 +179,19 @@ module Ruport
     
     def load_file( query_file )
       begin; File.read( query_file ).strip ; rescue
-        Ruport::complain "Could not open #{query_file}",
+        Ruport.log "Could not open #{query_file}",
           :status => :fatal, :exception => LoadError
       end
     end
     
-    def fetch(&action)
+    def fetch
       data = nil
       if @cache_enabled and @cached_data
         data = @cached_data
       else
         @statements.each { |query_text| data = query_data( query_text ) }
       end
-      data.each { |r| action.call(r) } if block_given? ; data
+      data.each { |r| yield(r) } if block_given? ; data
       @cached_data = data if @cache_enabled
       return data
     end

data/lib/ruport/rails/reportable.rb

@@ -1,17 +1,23 @@
 module Ruport
+  
   module Reportable
+    
     def formatted_table(type,options={})
       to_ds(:find => options[:find],:columns => options[:columns]).as(type){ |e|
         yield(e) if block_given?
       }
     end
+    
     def to_ds(options={})
      options[:columns] ||= column_names
      find(:all,options[:find]).
        to_ds(column_names).select_columns(*options[:columns])
     end
+
   end
+
   class DataSet
+    
     alias_method :old_append, :<<
     def <<( stuff, filler=@default )
       if stuff.kind_of?(ActiveRecord::Base)
@@ -20,6 +26,7 @@ module Ruport
         old_append(stuff,filler)
       end
     end
+
   end
 end
 

data/lib/ruport/report.rb

@@ -83,7 +83,8 @@ module Ruport
     def initialize( source_name=:default, mailer_name=:default )
       use_source source_name
       use_mailer mailer_name
-      @report_name = @results = ""
+      @report_name = "" 
+      @results     = ""
       @file        = nil
     end
     
@@ -100,7 +101,6 @@ module Ruport
     # Preserved for backwards compabilitity, please do not use this.
     alias_method :report=, :results=
 
-
     # Simplified interface to Ruport::Query
     #
     # === Can read SQL statements from file or string
@@ -157,7 +157,7 @@ module Ruport
     # This code will be evaluated in the context of the instance on which it is
     # called.
     def eval_template( code, filename=nil )
-      filename =~ /\.rb/ ? eval(code) : ERB.new(code, 0, "%").run(binding)
+      filename =~ /\.rb/ ? eval(code) : ERB.new(code, 0, "%").result(binding)
     end
    
     # sets the active source to the Ruport::Config source requested by label.
@@ -261,6 +261,19 @@ module Ruport
     def run(&block)
       self.class.run(self,&block)
     end
+
+    def load_csv(file,options={})
+      case options[:as]
+      when :table
+        Data::Table.load(file)
+      when :array
+        a = []
+        Data::Table.load(file) { |s,r| a << r }
+        return a
+      else
+        DataSet.load(file)
+      end
+    end
     
     # Preserved for backwards compatibility, please do not use this.
     alias_method :generate_report, :run
@@ -271,7 +284,6 @@ module Ruport
     # 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.
     #
-    # By default, this will
     def send_to(adds)
       m = Mailer.new
       m.to = adds

data/test/tc_config.rb

@@ -4,7 +4,6 @@ require "ruport"
 class TestConfiguration < Test::Unit::TestCase
 
   def setup
-    Ruport::Config.init!
     Ruport::Config.log_file = "test/unit.log"
   end
   
@@ -16,14 +15,6 @@ class TestConfiguration < Test::Unit::TestCase
     assert_equal(nil, Ruport::Config.default_mailer)
   end
 
-  def test_init
-     Ruport::Config.init!
-     assert_equal({}, Ruport::Config.sources)
-     assert_equal({}, Ruport::Config.mailers)
-     assert_equal(nil,Ruport::Config.logger)
-     assert_equal(false,Ruport::Config.paranoid?)
-  end
-
   def test_missing_dsn
    assert_raise(ArgumentError) {
      Ruport::Config.source :foo, :user => "root", :password => "fff"
@@ -68,10 +59,6 @@ class TestConfiguration < Test::Unit::TestCase
     # We have a logger running now, dont we?
     assert(Ruport::Config.logger.kind_of?(Logger)) 
       
-    # If we could go back in time and never define one...
-    Ruport::Config.init!
-    assert Ruport::Config.logger.nil?
-     
     # And then we change are mind again.  Back logging?
     Ruport::Config.log_file = "test/unit.log"  
     assert(Ruport::Config.logger.kind_of?(Logger))

data/test/tc_data_set.rb

@@ -275,6 +275,9 @@ class TestDataSet < Test::Unit::TestCase
     sum = data.sigma { |r| r["x"] }
     assert_equal(18,sum)
 
+    sum = data.sigma("x")
+    assert_equal(18,sum)
+
     #check alias
     sum = data.sum { |r| r["x"] }
     assert_equal(18,sum) 

data/test/tc_format.rb

@@ -1,3 +1,4 @@
+require "ruport"
 require "test/unit"
 
 class TestFormat < Test::Unit::TestCase

data/test/tc_format_engine.rb

@@ -24,6 +24,7 @@ class MockPlugin < Ruport::Format::Plugin
     eng.rewrite_column(0) { "a" } if apple 
   }
 
+  plugin_name :mock
   register_on :table_engine
   register_on :document_engine