ruport 0.4.17 → 0.4.19

data/CHANGELOG

@@ -1,4 +1,24 @@
-The current version of Ruby Reports is 0.4.17
+The current version of Ruby Reports is 0.4.19
+
+changes since 0.4.1
+
+- Made method_missing a lot more friendly all around.
+
+- Made minor interface changes.
+
+- Data::Table and Data::Record now dup correctly
+
+- Fixed some serious issues between Data::Table and TextPlugin
+
+- Report#eval_template now returns an ERb string instead of printing to STDOUT
+
+- Added Data::Table#split which allows basic grouping operations
+
+- Added Report#load_csv convenience method 
+
+- Tightened up Data::Table#<< to ensure column_names match record attributes
+
+- Fixed appending a Record in Data::Table#<<
 
 changes since 0.4.15
 
@@ -24,7 +44,7 @@ changes since 0.4.13
 
 - added accessor style methods to DataRow via method_missing
 
-- added prune method for Table formmatting. 
+- added prune method for Table formatting. 
 
 changes since 0.4.11
 

data/Rakefile

@@ -10,6 +10,9 @@ end
 
 #Set to true to disable dependency resolution
 LEAN=false
+dir = File.dirname(__FILE__)
+lib = File.join(dir, "lib", "ruport.rb")
+version = File.read(lib)[/^\s*VERSION\s*=\s*(['"])(\d+\.\d+\.d+)\1/,2]
 
 task :default => [:test]
 
@@ -21,7 +24,7 @@ end
 
 spec = Gem::Specification.new do |spec|
 	spec.name = LEAN ? "lean-ruport" : "ruport"
-	spec.version = "0.4.17"
+	spec.version = "0.4.19"
 	spec.platform = Gem::Platform::RUBY
 	spec.summary = "A generalized Ruby report generation and templating engine."
 	spec.files =  Dir.glob("{examples,lib,test}/**/**/*") +

data/lib/ruport.rb

@@ -12,9 +12,9 @@
 
 module Ruport
   
-  begin; require 'rubygems'; rescue LoadError; nil end
+  #begin; require 'rubygems'; rescue LoadError; nil end
   
-  VERSION = "Ruby Reports Version 0.4.17"
+  VERSION = "0.4.19"
   
   # Ruports logging and error interface.
   # Can generate warnings or raise fatal errors
@@ -31,7 +31,7 @@ module Ruport
   # The status <tt>:warn</tt> will invoke Logger#warn.  A status of
   # <tt>:fatal</tt> will invoke Logger#fatal and raise an exception
   # 
-  # By default, complain will also print warnings to $stderr
+  # By default, <tt>log()</tt> will also print warnings to $stderr
   # You can redirect this to any I/O object via <tt>:output</tt>
   #
   # You can prevent messages from appearing on the secondary output by setting
@@ -39,7 +39,7 @@ module Ruport
   # 
   # If you want to recover these messages to secondary output for debugging, you
   # can use Config::enable_paranoia 
-  def Ruport.log(message,options={})
+  def self.log(message,options={})
     options = {:status => :warn, :output => $stderr}.merge(options)
     options[:output].puts "[!!] #{message}" unless 
       options[:level].eql?(:log_only) and not Ruport::Config.paranoid?
@@ -49,9 +49,19 @@ module Ruport
     end
   end
  
-  def Ruport.complain(*args); Ruport.log(*args) end
-  
-  def Ruport.configure(&block)
+  #Alias for Ruport.log
+  def self.complain(*args); Ruport.log(*args) end
+ 
+  # yields a Ruport::Config object, allowing you to specify configuration
+  # options.
+  #
+  # Example: 
+  #
+  #   Ruport.configure do |c|
+  #     c.source :default, :dsn => "dbi:mysql:foo",
+  #                        :user => "clyde", :password => "pman"
+  #   end
+  def self.configure(&block)
     block.call(Ruport::Config)
   end
 end

data/lib/ruport/config.rb

@@ -9,7 +9,6 @@
 #
 # See LICENSE and COPYING for details
 #
-require "singleton"
 require "ostruct"
 module Ruport
   # This class serves as the configuration system for Ruport.
@@ -57,51 +56,49 @@ module Ruport
   # Saving this config information into a file and then requiring it can allow
   # you share configurations between Ruport applications.
   #
-  class Config
-    include Singleton
+  module Config
+    module_function
+    
+    def source(*args)
+      return sources[args.first] if args.length == 1
+      sources[args.first] = OpenStruct.new(*args[1..-1])
+      check_source(sources[args.first],args.first)
+    end
 
-    def Config.method_missing(method_id,*args)
-      case(method_id)
-      when :source
-        return @@sources[args.first] if args.length == 1
-        @@sources[args.first] = OpenStruct.new(*args[1..-1])
-        check_source(@@sources[args.first],args.first)
-      when :mailer
-        @@mailers[args.first] = OpenStruct.new(*args[1..-1])
-        check_mailer(@@mailers[args.first],args.first)
-      when :log_file,:log_file=
-        @@logger = Logger.new(args.first)
-      when :default_source
-        @@sources[:default]
-      when :default_mailer
-        @@mailers[:default]
-      when :sources
-        @@sources
-      when :mailers
-        @@mailers
-      when :logger
-        @@logger
-      when :enable_paranoia
-        @@paranoid = true
-      when :disable_paranoia
-        @@paranoid = false
-      when :paranoid?
-        @@paranoid
-      else
-        super
-      end 
+    def mailer(*args)
+      mailers[args.first] = OpenStruct.new(*args[1..-1])
+      check_mailer(mailers[args.first],args.first)
+    end
+
+    def log_file(file)
+      @logger = Logger.new(file)
     end
     
-    private
-    
-    def Config.init!
-      @@sources  = { }
-      @@mailers  = { }
-      @@logger   = nil
-      @@paranoid = false
+    #alias_method :log_file=, :log_file
+    def log_file=(file)
+      log_file(file)
+    end
+
+    def default_source
+      sources[:default]
     end
 
-    def Config.check_source(settings,label)
+    def default_mailer
+      mailers[:default]
+    end
+
+    def sources; @sources ||= {}; end
+
+    def mailers; @mailers ||= {}; end
+
+    def logger; @logger; end
+
+    def enable_paranoia; @paranoid = true; end
+    def disable_paranoia; @paranoid = false; end
+    def paranoid=(val); @paranoid = val; end
+    def paranoid?; !!@paranoid; end
+    
+    def check_source(settings,label)
       unless settings.dsn
         Ruport.complain( 
           "Missing DSN for source #{label}!",
@@ -111,7 +108,7 @@ module Ruport
       end
     end
 
-    def Config.check_mailer(settings, label)
+    def check_mailer(settings, label)
       unless settings.host
         Ruport.complain(
           "Missing host for mailer #{label}",
@@ -120,8 +117,6 @@ module Ruport
         )
       end
     end
-   
-    init!
     
   end
 end

data/lib/ruport/data/record.rb

@@ -12,7 +12,6 @@ module Ruport::Data
 
     attr_reader :data
     def_delegators :@data,:each, :length
-
   
     def [](index)
       if index.kind_of? Integer
@@ -31,16 +30,16 @@ module Ruport::Data
     end
 
     def ==(other)
-      return false if attributes && !other.attributes
-      return false if other.attributes && !attributes
-      (attributes == other.attributes) && (data == other.data)
+      return false if @attributes && !other.attributes
+      return false if other.attributes && !@attributes
+      @attributes == other.attributes && @data == other.data
     end
 
     alias_method :eql?, :==
     
-    def to_a; data.dup; end
+    def to_a; @data.dup; end
     
-    def to_h; Hash[*attributes.zip(data).flatten] end
+    def to_h; Hash[*@attributes.zip(data).flatten] end
 
     def attributes; @attributes && @attributes.dup; end
 
@@ -52,7 +51,7 @@ module Ruport::Data
 
     def reorder!(*indices)
       @data = indices.map { |i| self[i] }
-      if attributes
+      if @attributes
         if indices.all? { |e| e.kind_of? Integer }
           @attributes = indices.map { |i| @attributes[i] }
         else
@@ -62,7 +61,7 @@ module Ruport::Data
     end
 
     def dup
-      self.class.new(data,:attributes => attributes)
+      self.class.new(@data,:attributes => attributes)
     end 
     
     #FIXME: This does not take into account frozen / tainted state

data/lib/ruport/data/table.rb

@@ -7,13 +7,13 @@ module Ruport::Data
     end
 
     attr_reader :column_names
-    
+
     def column_names=(other)
       @column_names = other.dup
     end
 
     def <<(other)
-      case(other)
+      case other
       when Array
         @data << Record.new(other, :attributes => @column_names)
       when Hash
@@ -21,8 +21,10 @@ module Ruport::Data
         arr = @column_names.map { |k| other[k] }
         @data << Record.new(arr, :attributes => @column_names)
       when Record
-        @data << Record.reorder(*column_names)
+        raise ArgumentError unless column_names.eql? other.attributes
+        @data << Record.new(other.to_a, :attributes => @column_names)
       end
+      self
     end
 
     def reorder!(*indices)
@@ -34,6 +36,10 @@ module Ruport::Data
       dup.reorder! *indices
     end
 
+    def dup
+      a = self.class.new(:data => @data, :column_names => @column_names)
+    end
+
     def self.load(csv_file, options = {})
       options = {:has_names => true}.merge(options)
       require "fastercsv"
@@ -49,9 +55,37 @@ module Ruport::Data
         else
           yield(loaded_data,row)
         end
+      end ; loaded_data
+    end
+
+    def split(options={})
+      if options[:group].kind_of? Array
+        group = map { |r| options[:group].map { |e| r[e] } }.uniq
+         data = group.inject([]) { |s,g|
+           s + [select { |r| options[:group].map { |e| r[e] }.eql?(g) }]
+         }
+         c = column_names - options[:group]
+      else
+        group = map { |r| r[options[:group]] }.uniq 
+        data = group.inject([]) { |s,g| 
+          s + [select { |r| r[options[:group]].eql?(g) }] 
+        }
+        c = column_names - [options[:group]]
+
+      end 
+      data.map! { |g| 
+        Ruport::Data::Table.new(
+          :data => g.map { |x| x.reorder(*c) },
+          :column_names => c
+        )
+      }
+      if options[:group].kind_of? Array
+        Ruport::Data::Record.new(data, 
+          :attributes => group.map { |e| e.join("_") } )
+      else
+        Ruport::Data::Record.new data, :attributes => group
       end
-      return loaded_data
-    end 
+    end
 
   end
 end

data/lib/ruport/data_set.rb

@@ -48,7 +48,7 @@ module Ruport
     #an array which contains column names
     attr_accessor :fields
     alias_method  :column_names, :fields
-    
+    alias_method  :column_names=, :fields= 
     #the default value to fill empty cells with 
     attr_accessor :default
     
@@ -180,7 +180,7 @@ module Ruport
         input = FasterCSV.read(source) if source =~ /\.csv/
         loaded_data = self.new
         
-        action = if block_given? 
+        action = if block 
           lambda { |r| block[loaded_data,r] }
         else 
           lambda { |r| loaded_data << r } 
@@ -245,20 +245,13 @@ module Ruport
     # uses Format::Builder to render DataSets in various ready to output
     # formats.  
     #
-    #    data.as(:html)                  -> String
-    #
-    #    data.as(:text) do |builder|
-    #      builder.range = 2..4          -> String
-    #      builder.header = "My Title"
-    #    end
-    #
     # To add new formats to this function, simply re-open Format::Builder
     # and add methods like <tt>render_my_format_name</tt>. 
     #
     # This will enable <tt>data.as(:my_format_name)</tt>
-    def as(format,&action)
+    def as(format)
       t = Format.table_object(:data => self, :plugin => format)
-      action.call(t) if block_given?
+      yield(t) if block_given?
       t.render
     end
     
@@ -266,9 +259,15 @@ module Ruport
     # The result of the block will be added to a running total
     #
     # Only works with blocks resulting in numeric values.
-    def sigma
-      inject(0) do |s,r|
-        s + (yield(r) || 0)
+    #
+    # Also allows summing up a specific column, e.g.
+    #
+    #   my_set.sigma("col1")
+    def sigma(f = nil)
+      if f
+        inject(0) { |s,r| s + (r[f] || 0) }
+      else
+        inject(0) { |s,r| s + (yield(r) || 0) }
       end
     end
     

data/lib/ruport/format.rb

@@ -67,7 +67,7 @@ module Ruport
     # These interfaces pass a hash of keywords to the associative engine.  
     # Here is a simple example:
     # 
-    # Format.build_interface_for Format::Engine::Yable, "table"
+    # Format.build_interface_for Format::Engine::Table, "table"
     # 
     # This will allow the following code to work:
     # 
@@ -81,10 +81,10 @@ module Ruport
     # which would be accessible via
     #
     # Format.my_name ...
-    def Format.build_interface_for(engine,name)
-      (class << self; self; end).send(:define_method, name, 
+    def self.build_interface_for(engine,name)
+      singleton_class.send(:define_method, name, 
         lambda { |options| simple_interface(engine, options) })
-      (class << self; self; end).send(:define_method, "#{name}_object",
+      singleton_class.send(:define_method, "#{name}_object",
         lambda { |options|
           options[:auto_render] = false; simple_interface(engine,options) })
     end
@@ -100,8 +100,8 @@ module Ruport
     # evaluated in the context of the object they are being called from, rather
     # than within an instance of Format.
     #
-    def initialize(klass_binding=binding)
-      @binding = klass_binding
+    def initialize(class_binding=binding)
+      @binding = class_binding
     end
     
     # This is the text to be processed by the filters
@@ -114,7 +114,7 @@ module Ruport
     # of the object that Format is bound to.
     def filter_erb  
       self.class.document :data => @content, 
-                          :klass_binding => @binding,
+                          :class_binding => @binding,
                           :plugin => :text
     end
     
@@ -137,18 +137,18 @@ module Ruport
     #   Format.register_filter :no_ohz do
     #     content.gsub(/O/i,"")
     #   end
-    def Format.register_filter(name,&filter_proc)
+    def self.register_filter(name,&filter_proc)
       @@filters["filter_#{name}".to_sym] = filter_proc 
     end
 
-    def method_missing(m)
+    def method_missing(m,*args)
       @@filters[m] ? @@filters[m][@content] : super
     end
 
 
     private
 
-     def Format.simple_interface(engine, options={})
+     def self.simple_interface(engine, options={})
         my_engine = engine.dup
         
         my_engine.send(:plugin=,options[:plugin])