ruport 0.4.11 → 0.4.13

data/CHANGELOG

@@ -1,4 +1,32 @@
-The current version of Ruby Reports is 0.4.11
+The current version of Ruby Reports is 0.4.13
+
+changes since 0.4.11
+
+- Added high level hook Report#text_processor which essentially works like
+  Format.register_filter
+
+- Report can now run single or multiple reports and do things such as send them
+  via email or write/append them to files.
+
+- Report has been overhauled to have a simple DSL
+
+- Mailfactory is now a gem dependency.  If you install via setup.rb or building
+  the gem yourself, you only need it if you plan to use Ruport::Mailer
+
+- Report#query now has an 'as' method that allows direct translation of a query
+  to a particular format, e.g.
+
+  query "select * from ruport", :as => :pdf
+
+- Lots of bug fixes and cleanup
+
+- Ruport is now on Trac.
+  http://stonecode.svnrepository.com/ruport/
+
+- I apparently never knew how to use inject.  
+  Injects are all functional now.
+
+- Fixed a bug in DataSet that made fields not get duped properly
 
 changes since 0.4.9
 

data/README

@@ -1,8 +1,8 @@
 # ------------------------------------------------------------------------
 # -------------------------------------------------------------------------
-#
-# WARNING: THIS DOCUMENT IS FREQUENTLY OUT OF DATE.
 # 
+# NOTE:
+#
 # The most up to date information can be found at:
 # http://reporting.stonecode.org
 #
@@ -24,9 +24,9 @@
 #
 # - Installation 
 #
-#  Optional Dependencies:
+#  Dependencies:
 #   
-#    Ruport has a number of dependencies:
+#    Ruport has a number of dependencies.
 #     
 #    Ruby/DBI and appropriate dbds: Makes Query useable 
 #    (must be installed manually)
@@ -37,9 +37,11 @@
 #    RedCloth:  Enables textile/markdown filtering
 #    (available via rubygems)
 #    
-#    PDF::Writer: Enables printable documents via render_pdf (Experimental)
+#    PDF::Writer: Enables printable documents 
 #    (available via rubygems)
 #
+#    MailFactory: For email support. 
+#
 #  Note that by installing any of the dependencies, either via gems or manually,
 #  their functionality will automatically be enabled.
 #
@@ -64,7 +66,7 @@
 #
 # - Caveats 
 #
-#  Ruport is alpha software.  It's not completely tested and the API is
+#  Ruport is experimental software.  It's not completely tested and the API is
 #  changing rapidly from version to version.  Test suites are becoming
 #  increasingly robust, but have not identified all possible edge cases.  If
 #  Ruport goes wild on you, it's because it hasn't been tamed yet.
@@ -105,9 +107,9 @@
 #    http://rubyforge.org/projects/ruport
 #
 #  - The latest stable API documentation is available at:
-#    http://ruport.rubyforge.org/docs
+#    http://reporting.stonecode.org/docs
 #
-#  There also will be some tutorials on stonecode.org
+#  There also will be some tutorials on ruport.infogami.com
 #
 #  If you are interested in developing Ruport, please *never* study code in
 #  official releases.  As this software is in it's early stages, it's essential
@@ -121,7 +123,7 @@
 #
 #  Those who would like to become regular contributors will be given write
 #  access.  Also, anyone interested in the internal design and project
-#  management aspects of Ruport can request to be added to our basecamp
+#  management aspects of Ruport can request to be added to our Trac
 #  account.  This is primarily intended for people who are working on the
 #  project actively, though.
 #
@@ -150,25 +152,13 @@
 #  Format provides support for building filters and specialized formatting
 #  systems. 
 # 
-#  Query currently provides a high level interface to DBI.  Soon it will support
-#  a mixin wrapper called Fetchable which will enable you to wrap whatever data
-#  source you choose.  If you would like to query a database or load a sql dump,
-#  this class can help you do that.  It can generate DataSets on the fly, or feed
-#  you DBI:Rows, depending on what you need.
-#
-#  There is also a Config class which allows you to set things such as data
-#  sources, mailer information, and logging.  Ruport#complain provides a robust
-#  way to handle error logging and warnings.
-#
-#  Finally, Ruport provides a powerful yet oh-so-scary parsing tool.  It is
-#  essentially James Edward Gray II's Parse::Input library within the Ruport
-#  library.  (And will soon be integrated nicely too)
-#
-#  Read the source of ruport/parser.rb if you have some gnarly data you need to
-#  munge.
+#  Query currently provides a high level interface to DBI.
+#  If you would like to query a database or load a sql dump, 
+#  this class can help you do that.  It can generate DataSets on the fly, 
+#  or feed you DBI:Rows, depending on what you need.
 #
 #  Finally, Please consult the API documentation and/or source code for more
-#  information. (http://ruport.rubyforge.org/docs).  Not all classes have been
+#  information. (http://reporting.stonecode.org/docs).  Not all classes have been
 #  documented but the ones that have may be easier to understand when their docs
 #  have been read.  Also, feel free to contribute documentation.
 #

data/Rakefile

@@ -21,7 +21,7 @@ end
 
 spec = Gem::Specification.new do |spec|
 	spec.name = LEAN ? "lean-ruport" : "ruport"
-	spec.version = "0.4.11"
+	spec.version = "0.4.13"
 	spec.platform = Gem::Platform::RUBY
 	spec.summary = "A generalized Ruby report generation and templating engine."
 	spec.files =  Dir.glob("{examples,lib,test}/**/**/*") +
@@ -39,6 +39,7 @@ spec = Gem::Specification.new do |spec|
     spec.add_dependency('fastercsv', '>= 0.1.0')
     spec.add_dependency('RedCloth',  '>= 3.0.0')
     spec.add_dependency('pdf-writer', '>= 1.1.3')
+    spec.add_dependency("mailfactory", ">= 1.2.2")
   end
   spec.author = "Gregory Brown"
 	spec.email = "	gregory.t.brown@gmail.com"

data/TODO

@@ -4,6 +4,8 @@ Immediate Goals:
 
   Features:
 
+    - PDF document support + example
+
     - event system
  
     - Composite key selection
@@ -14,24 +16,8 @@ Immediate Goals:
       
     - Column based default values
 
-    - Integrate Ruport::Parser into Report#parse and Format#parser
-
     - Document the inner classes of Format
 
     - make the Fetchable module to abstract data acquisition
   
     - Calculated fields
-
-Other High Priority Goals:
-
-  - Offer charting support in Format
-
-Community Requests:
-
-  - Integration with Rails (ActiveRecord)
-
-Other (Unordered) Goals:
-
-  - Support KirbyBase
-
-  - More Secure passwords for SQL

data/examples/report.rb

@@ -0,0 +1,35 @@
+require "ruport"
+require "fileutils"
+class MyReport < Ruport::Report
+  prepare do
+    log_file "f.log"
+    log "preparing report", :status => :info
+    source :default, 
+      :dsn => "dbi:mysql:foo", 
+      :user => "root"
+    mailer :default,
+     :host => "mail.adelphia.net", 
+     :address => "gregory.t.brown@gmail.com"
+  end
+  
+  generate do
+    log "generated csv from query", :status => :info
+    query "select * from bar", :as => :csv 
+  end
+
+  cleanup do
+    log "removing foo.csv", :status => :info
+    FileUtils.rm("foo.csv") 
+  end
+end
+
+MyReport.run { |res| 
+  res.write "foo.csv";
+  res.send_to("greg7224@gmail.com") do |mail|
+    mail.subject = "Sample report" 
+    mail.attach "foo.csv"
+    mail.text = <<-EOS
+      this is a sample of sending an emailed report from within Ruport.
+    EOS
+  end
+}

data/examples/template.rb

@@ -0,0 +1,15 @@
+require "ruport"
+
+TEMPLATE = <<-EOS
+
+My HTML Table:
+  <%= query "select * from bar", :as => :html %>
+
+EOS
+
+class MyReport < Ruport::Report
+  prepare  { source :default, :dsn => "dbi:mysql:foo", :user => "root" }
+  generate { eval_template TEMPLATE }
+end
+
+MyReport.run

data/examples/text_processors.rb

@@ -0,0 +1,20 @@
+require "ruport"
+
+
+class MyReport < Ruport::Report
+  prepare {
+    self.results = "Foo Bar Baz"
+    text_processor(:replace_foo) { results.gsub!(/Foo/,"Ruport") }
+    text_processor(:replace_bar) { results.gsub!(/Bar/,"Is") }
+    text_processor(:replace_baz) { results.gsub!(/Baz/, "Cool!") }
+  }
+  generate {
+    process_text results, :filters => [:replace_foo,:replace_bar,:replace_baz]
+  }
+end
+
+MyReport.run { |e| puts e.results }
+    
+
+
+  

data/lib/ruport.rb

@@ -14,7 +14,7 @@ module Ruport
   
   begin; require 'rubygems'; rescue LoadError; nil end
   
-  VERSION = "Ruby Reports Version 0.4.11"
+  VERSION = "Ruby Reports Version 0.4.13"
   
   # Ruports logging and error interface.
   # Can generate warnings or raise fatal errors
@@ -39,24 +39,21 @@ module Ruport
   # 
   # If you want to recover these messages to secondary output for debugging, you
   # can use Config::enable_paranoia 
-  def Ruport.complain(message,options={})
-    options[:status] ||= :warn
-    options[:output] ||= $stderr
+  def Ruport.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?
-    case(options[:status])
-    when :warn
-      Ruport::Config::logger.warn(message) if Ruport::Config.logger
-    when :fatal
-      Ruport::Config::logger.fatal(message) if Ruport::Config.logger
-      raise options[:exception] || RuntimeError, message
+    Ruport::Config::logger.send(options[:status],message) if Config.logger
+    if options[:status].eql? :fatal
+      raise(options[:exception] || RuntimeError, message) 
     end
   end
-
+ 
+  def Ruport.complain(*args); Ruport.log(*args) end
+  
   def Ruport.configure(&block)
     block.call(Ruport::Config)
   end
-
 end
 
 

data/lib/ruport/config.rb

@@ -59,7 +59,7 @@ module Ruport
   #
   class Config
     include Singleton
-    
+
     def Config.method_missing(method_id,*args)
       case(method_id)
       when :source
@@ -69,7 +69,7 @@ module Ruport
       when :mailer
         @@mailers[args.first] = OpenStruct.new(*args[1..-1])
         check_mailer(@@mailers[args.first],args.first)
-      when :log_file
+      when :log_file,:log_file=
         @@logger = Logger.new(args.first)
       when :default_source
         @@sources[:default]

data/lib/ruport/data_set.rb

@@ -39,7 +39,7 @@ module Ruport
     # length, empty?, delete_at, first, last, pop
     # 
     def initialize(fields=nil, options={})
-      @fields = fields
+      @fields = fields.dup if fields
       @default = options[:default] || default
       @data = []
       options[:data].each { |r| self << r } if options[:data]
@@ -97,6 +97,8 @@ module Ruport
     # 
     #    data << [ 1, 2, 3 ]
     #    data << { :some_field_name => 3, :other => 2, :another => 1 }
+    #
+    # FIXME: Appending a datarow is wonky.
     def << ( stuff, filler=@default )
       if stuff.kind_of?(DataRow)
         @data << stuff.clone
@@ -184,9 +186,10 @@ module Ruport
           lambda { |r| loaded_data << r } 
         end
        
-        loaded_data.fields = input[0] if options[:has_names]
-        input = input[1..-1] if options[:has_names] 
-        
+        if options[:has_names]
+          loaded_data.fields = input[0] ; input = input[1..-1]
+        end
+
         loaded_data.default = options[:default]
         input.each { |row| action[row] }
         return loaded_data	
@@ -199,7 +202,7 @@ module Ruport
     # Returns a new DataSet composed of the fields specified.
     def select_columns(*fields)
       fields = get_field_names(fields)
-      rows = fields.inject([]) { |s,e| s << map { |row| row[e] } }.transpose
+      rows = fields.inject([]) { |s,e| s + [map { |row| row[e] }] }.transpose
       my_data = DataSet.new(fields, :data => rows)
     end
     
@@ -257,7 +260,7 @@ module Ruport
     # Only works with blocks resulting in numeric values.
     def sigma
       inject(0) do |s,r|
-        s += yield(r) || 0
+        s + (yield(r) || 0)
       end
     end
     
@@ -281,7 +284,7 @@ module Ruport
 
     def get_field_names(f)
       f.all? { |e| e.kind_of? Integer } &&
-      f.inject([]) { |s,e| s << @fields[e] } || f
+      f.inject([]) { |s,e| s + [@fields[e]] } || f
     end
     
   end

data/lib/ruport/format.rb

@@ -59,41 +59,40 @@ module Ruport
 # This part of Ruport is under active development.  Please do feel free to
 # submit feature requests or suggestions.
   class Format
-      
-      def Format.build_interface_for(engine,name)
-        (class << self; self; end).send(:define_method, name, 
-          lambda { |options| simple_interface(engine, options) })
-        (class << self; self; end).send(:define_method, "#{name}_object",
-          lambda { |options|
-            options[:auto_render] = false; simple_interface(engine,options) })
-      end
-
-      %w[open_node document engine plugin].each { |lib|
-         require "ruport/format/#{lib}" 
-      }
-
-    class << self      
-
-      def simple_interface(engine, options={})
-        my_engine = engine.dup
-        
-        my_engine.send(:plugin=,options[:plugin])
-        options = my_engine.active_plugin.rendering_options.merge(options)
-       
-        options[:auto_render] = true unless options.has_key? :auto_render
-        
+    
+    # Builds a simple interface to a formatting engine.
+    # Two of these interfaces are built into Ruport:
+    # Format.document and Format.table
+    #
+    # These interfaces pass a hash of keywords to the associative engine.  
+    # Here is a simple example:
+    # 
+    # Format.build_interface_for Format::Engine::Yable, "table"
+    # 
+    # This will allow the following code to work:
+    # 
+    # Format.table :data => [[1,2],[3,4]], :plugin => :csv
+    #  
+    # So, if you want to create a standard interface to a 
+    # custom built engine, you could simply do something like:
+    # 
+    # Format.build_interface_for MyCustomEngine, "my_name"
+    #
+    # which would be accessible via
+    #
+    # Format.my_name ...
+    def Format.build_interface_for(engine,name)
+      (class << self; self; end).send(:define_method, name, 
+        lambda { |options| simple_interface(engine, options) })
+      (class << self; self; end).send(:define_method, "#{name}_object",
+        lambda { |options|
+          options[:auto_render] = false; simple_interface(engine,options) })
+    end
 
-        options[:data] = options[:data].dup
-        
-        options.each do |k,v|
-          my_engine.send("#{k}=",v) if my_engine.respond_to? k
-        end
-        
-        options[:auto_render] ? my_engine.render : my_engine.dup
-      end
+    %w[open_node document engine plugin].each { |lib|
+       require "ruport/format/#{lib}" 
+    }
 
-    end
-   
     @@filters = Hash.new
     
     # To hook up a Format object to your current class, you need to pass it a
@@ -101,7 +100,7 @@ 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)
+    def initialize(klass_binding=binding)
       @binding = klass_binding
     end
     
@@ -143,9 +142,32 @@ module Ruport
     end
 
     def method_missing(m)
-      @@filters[m] ? @@filters[m].call(@content) : super
+      @@filters[m] ? @@filters[m][@content] : super
     end
-  
+
+
+    private
+
+     def Format.simple_interface(engine, options={})
+        my_engine = engine.dup
+        
+        my_engine.send(:plugin=,options[:plugin])
+        options = my_engine.active_plugin.rendering_options.merge(options)
+       
+        options[:auto_render] = true unless options.has_key? :auto_render
+        
+
+        options[:data] = options[:data].dup
+        
+        options.each do |k,v|
+          my_engine.send("#{k}=",v) if my_engine.respond_to? k
+        end
+        
+        options[:auto_render] ? my_engine.render : my_engine.dup
+      end
+
+
+    
   end
 end