ruport 0.1.0 → 0.2.0

data/AUTHORS

@@ -0,0 +1 @@
+{Gregory Brown}[mailto:gregory.t.brown@gmail.com]

data/CHANGELOG

@@ -0,0 +1,45 @@
+changes since Ruport 0.1.0:
+
+CLEANUP / ORGANIZATION:
+
+- Parseinput dependency removed for now
+
+- setup.rb support removed
+
+- gem install will now only install a single executable
+
+- dropped undocumented YAML override feature
+
+- Query class now called Report
+
+- Project split into two parts lib/ruport/db and lib/ruport/format
+
+- dropped questionable ruport_query manager function
+
+- finally turned on expandtab and tabstop=2 for Ruby style ;)
+
+FEATURES:
+
+- require 'ruportlib' lets ruport be used as a library
+
+- MockDB and MockReport added to simplify testing
+
+- DataRow and DataSet added to provide munging with ease
+  (to_csv, DataSet.load("some.csv"), etc
+
+- DataSet.load() can restore DataSet's that were YAML.dump()'ed
+
+- load_file now supports absolute and relative paths
+
+- added many automation features to templates
+
+- added @pre and @post to Report which accept lambdas to execute
+  before and after generate_report()
+
+- logger added.
+
+- some friendly error messages added
+ 
+- new method query() will eventually replace select() / execute()
+
+- {examples}[http://ruport.rubyforge.org/examples.zip] available for download

data/README

@@ -1,12 +1,14 @@
 Thank you for taking the time to download Ruby Reports. (Ruport)
 
-This software is a powerful report generation engine that allows users to generate custom ERb templates and easily query various forms of SQL databases via DBI.It provides helper methods and utilities to generate professional reports quickly and cleanly.
+This software is a powerful report generation engine that allows users to
+generate custom ERb and pure ruby templates that can easily query various forms
+of databases via DBI.  It also provides helper methods and utilities to generate professional reports quickly and cleanly.
 
-It is also alpha software, so if it offends your mother, burns out the innards
-of your computer, or threatens you in any other way, you may want to wait until
-further releases to play around with it.
+It happens to be alpha software, so if it offends your mother, burns out the innards of your computer, or threatens you in any other way, you may want to wait until further releases to play around with it.
 
-There is a user's manual for this application available at http://ruport.rubyforge.org/ruport_manual.pdf which I strongly recommend reading.
+There is a set of examples and a brief walkthrough for this application
+available at http://ruport.rubyforge.org/examples.zip which I strongly
+recommend going through
 
 Otherwise, here is a brief set of installation and setup instructions which will
 hopefully get you going:
@@ -19,8 +21,18 @@ your database and operating system setup, I will not go into the instructions
 in detail here.  However, it essentially boils down to finding your database
 software in the list of drivers on http://ruby-dbi.sourceforge.net/ and 
 downloading and installing the driver.  Once this is complete, you download and install DBI using the instructions at the aformentioned link.  We have
-successfully installed RubyDBI with a MySQL driver on Gentoo Linux and Mac OS X.  
-We have also successfully installed RubyDBI on Windows using ODBC. 
+successfully installed RubyDBI with a MySQL driver on Gentoo Linux, Windows
+2000/XP and Mac OS X.3, X.4.  
+
+There is a tutorial available for installing Ruport and MySQL on Windows
+at: http://stonecode.org:2501/stonecodeproductions/published/Ruport%2C+MySQL+and+Windows
+
+If you're having problems getting mysqld_safe running on Mac OS X,
+you might check out this:
+
+http://stonecode.org:2501/stonecodeproductions/published/Why+OS+X+MySQL+won%27t+start+the+server
+
+We have also successfully installed RubyDBI on Windows 2000 using ODBC. 
 If you are running a similar setup, feel free to email gregory.t.brown@gmail.comwith any questions.  If you successfully install Ruby/DBI on another system /
 database combination, we'd love to hear how you did it so that  we can improve
 this documentation for the next version of Ruport.  Once you've got DBI 
@@ -30,36 +42,43 @@ Ruport is a gem.  It relies on Parse/Input (which will be linked to Ruport
 in future releases) but this can easily be installed using the
 --include-dependencies flag.  Make sure you have adequete permissions and run:
 
-	sudo gem install ruport --include-dependencies
+	sudo gem install ruport
 
 on Linux, OS X, and other Unix like systems.  
 
 On Windows, ensure that you have adequete permission to install
 software and run:
 	 
-	gem install ruport --include-dependencies
+	gem install ruport
 
 With any luck, Ruport is now installed and you are ready to move on to
 setting up and configuring a sandbox.
 
 To check to see if the ruport executable has been added to you path and is
-working in at least minimal capacity, type ruport -v at the command prompt.
+working in at least minimal capacity, type:
+
+ruport -v
+
+at the command prompt.
 
 If you see something like this:
 
-	Ruport Version 0.1.0  ...
+	Ruport Version x.y.z  ...
 
 then Ruport is at least installed and running.  
 
 If you get an error instead, feel free to email me,
 but please include the error message.
 
-To generate a sandbox, type ruport generate sandbox_name.
+To generate a new project, type:
+  
+  ruport generate ProjectName
+
 This will dump a directory structure for you to start with.
 
 You'll need to edit config/ruport.yaml to get things up and running, and at this
 point, unless you're magic, you'll probably need to either read the
-{manual}[http://ruport.rubyforge.org/ruport_manual.pdf] or the source, whichever
+{API Documentation}[http://ruport.rubyforge.org/docs/] or the source, whichever
 you're most comfortable with.
 
 I hope you enjoy this software and that it is useful to you.

data/Rakefile

@@ -1,51 +1,48 @@
-require "rake/rdoctask"
-require "rake/testtask"
-require "rake/gempackagetask"
-
-require "rubygems"
-
-task :default => [:test]
-
-Rake::TestTask.new do |test|
-	test.libs << "test"
-	test.test_files = [ "tests/tc_ruport.rb" ]
-	test.verbose = true
-end
-
-spec = Gem::Specification.new do |spec|
-	spec.name = "ruport"
-	spec.version = "0.1.0"
-	spec.platform = Gem::Platform::RUBY
-	spec.summary = "A generalized Ruby report generation and templating engine."
-
-	spec.files = Dir.glob("{bin,lib,tests}/**/*.rb").
-	                 delete_if { |item| item.include?("CVS") } +
-	                 ["Rakefile", "setup.rb"]
-	spec.require_path = "lib"
-	spec.bindir = "bin"
-	spec.executables << "ruport" << "ruport.rb" 
-	
-	spec.has_rdoc = true
-	spec.extra_rdoc_files = %w{README LICENSE TODO}
-	spec.rdoc_options << '--title' << 'Ruport Documentation' <<
-	                     '--main'  << 'README'
-
-	spec.add_dependency("parseinput", ">= 0.0.1")
-
-	spec.author = "Gregory Brown"
-	spec.email = "	gregory.t.brown@gmail.com"
-	spec.rubyforge_project = "ruport"
-	spec.homepage = "http://ruport.rubyforge.org"
-	spec.description = <<END_DESC
-Ruport is a powerful report generation engine that allows users to generate
-custom ERb templates and easily query various forms of SQL databases via DBI.
-It provides helper methods and utilities to generate professional reports
-quickly and cleanly.
-END_DESC
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-	pkg.need_zip = true
-	pkg.need_tar = true
-end
-
+require "rake/rdoctask"
+require "rake/testtask"
+require "rake/gempackagetask"
+
+require "rubygems"
+
+task :default => [:test]
+
+Rake::TestTask.new do |test|
+	test.libs << "test"
+	test.test_files = [ "test/ts_all.rb" ]
+	test.verbose = true
+end
+
+spec = Gem::Specification.new do |spec|
+	spec.name = "ruport"
+	spec.version = "0.2.0"
+	spec.platform = Gem::Platform::RUBY
+	spec.summary = "A generalized Ruby report generation and templating engine."
+
+	spec.files = Dir.glob("{bin,lib,test}/**/*.rb").
+	                 delete_if { |item| item.include?("CVS") } +
+	                 ["Rakefile"]
+	spec.require_path = "lib"
+	spec.bindir = "bin"
+	spec.executables << "ruport"
+	
+	spec.has_rdoc = true
+	spec.extra_rdoc_files = %w{README LICENSE TODO AUTHORS CHANGELOG}
+	spec.rdoc_options << '--title' << 'Ruport Documentation' <<
+	                     '--main'  << 'README'
+
+	spec.author = "Gregory Brown"
+	spec.email = "	gregory.t.brown@gmail.com"
+	spec.rubyforge_project = "ruport"
+	spec.homepage = "http://ruport.rubyforge.org"
+	spec.description = <<END_DESC
+Ruport is a powerful report generation engine that allows users to generate
+custom ERb templates and easily query various forms of SQL databases via DBI.
+It provides helper methods and utilities to generate professional reports
+quickly and cleanly.
+END_DESC
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+	pkg.need_zip = true
+	pkg.need_tar = true
+end

data/TODO

@@ -1,19 +1,19 @@
 TODO:
 
-Take the following features and stabilize them for Ruport 0.2.0:
+Improvement:
 
 - Mail system
-
-	Hook up unit tests and solidify system
+	Hook up unit tests
+	Make attachments doable
 
 - Template Config / Line Editing
 
 	Find a way to accept piped in values
-	Hook up unit tests.
+	Make line editing work right
 	
 - Queries Table System
 
-	Write a cross-database table creation script
+	Automate the generation of the table. (Optionally)
 	Hook up unit tests.
 
 - SQL builder
@@ -24,6 +24,16 @@ Take the following features and stabilize them for Ruport 0.2.0:
 
 Begin implementing new features:
 
+  DSNs:
+
+  It would be nice to be able to configure any number of databases
+  and then select them by name. (JEG2)
+
+	Charts:
+
+		Build something that'll take a data set and build a chart. (SVG?),
+		then dump it into PDF::Writer.
+
 	Multiple query reports:
 	
 		Allow the user to make arbitrary SQL queries,
@@ -39,14 +49,6 @@ Begin implementing new features:
 		regardless of database choice and import the data stored in a file into
 		a specified table.
 
-	YAML dump / restore:
-		
-		Make a nice way to dump the results of a query to a yaml file,
-		potentially to be read back in and reconstructed by another ruport
-		template.  This would require splitting the formatting and data feeder
-		functionality, but would allow a user to simply load in a YAML file and
-		apply arbitrary formatting.
-
 	Parse/Input tight integration:
 
 		Write wrapper functions over the Parse/Input library to give Ruport the
@@ -60,11 +62,14 @@ Begin implementing new features:
 		and over again.  This would be especially useful for just dumping a
 		table's values in a certain order with some fields removed.
 
+    [UPDATE: to_csv is in place but can use some additional frosting]
+
 	Logger / Exception handler:
 
 		Create a system to handle and log errors as well as provide log messages
 		regarding what Ruport does when a template is run.
-
+    
+    [UPDATE: Logger is in place but is not covering many functions]
 
 Design considerations:
 
@@ -72,18 +77,19 @@ Design considerations:
 	tools and data feeders.  This will likely happen in an early release, if not
 	the next than the one after.
 
+  [ UPDATE:  The folders have been seperated but need reworking.  db/mailer ??
+             Ruport needs to be made into a module ]
+
 	Ruport trys to use a lot of 'intelligent' defaults but it might try to be
 	too clever in some places making it not clever at all.  The community
 	reaction will determine what places may need opening up more or need more
 	consideration for the defaults.
-
-	"Fix the lame hack that installs two executables" (James Edward Gray II)
-
+  
+  [ UPDATE: See changelog for a list of dropped features.  Complain about any
+  that you still think need to be dropped ]
 
 Other:
 
-	A full set of examples should be made available for download.
-
 	A quick reference page for templates and/or tutorial would be A Good Thing
 
 	The RDOC sucks!
@@ -92,10 +98,18 @@ Other:
 	of additional steps, they need to be expanded to cover the whole system, and
 	they need to work in the Gem package as well as the source package.
 
+  [UPDATE: Mailer is the only class that needs to be unit tested still.  The
+           units work out of the box via MockDB now.  Functional tests with
+           scaffolding are needed, though ]
+
 	Ruport needs to be modified to support as many databases as possibly
-	internally.  The system was written with Linux/MySQL and Windows/MS SQL
-	(ODBC) in mind.  This will change when feedback from the community is
-	recieved.
+	internally.  The system was written using MySQL on Gentoo Linux
+	and Mac OS X.3 / OS X.4, Windows 2000 / XP 
+  
+  and Microsoft SQL Server on Windows 2000 (via ODBC),
+	
+  so the support for these platforms are best.  An effort will be given to
+	make Ruport less hostile in other environments.
 
 
 This is only the tip of the iceburg.  Please feel free to continue to fill my
@@ -103,4 +117,3 @@ plate by sending any suggestions to gregory.t.brown@gmail.com
 	
 
 		
-

data/bin/ruport

@@ -13,74 +13,92 @@
 # for providing the original source code for this application
 
 require "rubygems"
-require "query"
-require "mailer"
 require "ftools"
+require "yaml"
+require "ruportlib"
 
-if ARGV[0].eql?("generate")
-	if ARGV[1].nil?
-		puts "You must specify a name for your ruport sandbox"
-		exit
-	end
-	Dir.mkdir(ARGV[1])
-	Dir.mkdir("#{ARGV[1]}/reports")
-	Dir.mkdir("#{ARGV[1]}/templates")
-	Dir.mkdir("#{ARGV[1]}/config")
-	Dir.mkdir("#{ARGV[1]}/queries")
-	conf =  ":driver: 'DBI:mysql'\n"+
-	        ":database: test\n"+
-			":db_user:\n:db_password:\n:mail_host:\n:mail_account:\n"+        
-			":mail_password:\n:mail_address:\n:mail_authentication:\n"+ 
-			":query_table: ruport_queries"
-			    
-	File.open("#{ARGV[1]}/config/ruport.yaml", "w") { |f| f.puts(conf) }
-	File.open("#{ARGV[1]}/templates/test.rb", "w") { |f|
-		f.puts 'select "database()" do |r| puts r end'
-	}
-	exit
-elsif ARGV[0].eql?("-v")
-	puts "Ruport Version 0.1.0 \nA ruby report generation system by Gregory " +
-	"Brown.\nThis application is Free Software under the GPL/Ruby License. " +
-	"\nAll praise and/or criticism can be directed to "+
-	"gregory.t.brown@gmail.com"
-	exit
-end
-config = YAML.load(File.open("config/ruport.yaml"))
-mailer = nil
+# The whole codebase below is scary, dirty, and evil.
+# The library itself is much cleaner.  This is a total hack.
 
-if config.has_key?(:mail_host)
-	mailer = Mailer.new( config[:mail_host],
-						 config[:mail_address],
-	                     config[:mail_account],
-						 config[:mail_password],
-						 config[:mail_port],
-						 config[:mail_authentication] )
+if ARGV[0].nil?
+  puts "Usage: ruport path/to/template or ruport generate project_name"
+  exit
 end
 
+if ARGV[0].eql?("generate")
+  if ARGV[1].nil?
+    puts "You must specify a name for your ruport sandbox"
+    exit
+  end
+  Dir.mkdir(ARGV[1])
+  Dir.mkdir("#{ARGV[1]}/log")
+  Dir.mkdir("#{ARGV[1]}/reports")
+  Dir.mkdir("#{ARGV[1]}/templates")
+  Dir.mkdir("#{ARGV[1]}/config")
+  Dir.mkdir("#{ARGV[1]}/queries")
+  conf = (<<-END_CONF
+  # any DBI driver ('DBI:mysql', 'DBI:odbc', etc) or Ruport's mock ('ruport') 
+  :driver: 
+
+  #The database to connect to. For remote database: 'foo:hostname' or 'foo:ip'
+  :database:
 
-query  = Query.new( "#{config[:driver]}:#{config[:database]}",
-                    config[:db_user], config[:db_password], mailer)
+  # username.  for local auth, leave blank
+  :db_user:
 
-query.query_table = config[:query_table]
+  :db_password:
 
+  #mail info, if you want mail support, fill out.  Otherwise leave blank        
+  :mail_host:
+  :mail_account:
+  :mail_password:
+  :mail_address:
+  :mail_authentication:
+  :query_table:
 
-case(ARGV[0])
-when "ins_query", "insq"
-	query_text =  query.load_file(ARGV[2])
-	query.execute("INSERT INTO #{query.query_table} " +
-	              "VALUES ('#{ARGV[1]}','#{query_text}' );")
-when "ls_queries", "lsq"
-	query.select("label FROM #{query.query_table}") do |r| puts r end
-when "show_query", "sq"
-	query.select( "query FROM #{query.query_table} " +
-	              "WHERE label LIKE '%#{ARGV[1]}%'" ) do |r| puts r end
-when "rm_query", "rmq"
-	query.execute("DELETE FROM #{query.query_table} " +
-				   "WHERE label LIKE '#{ARGV[1]}'" )
-else
-	query.eval_report(ARGF.filename, ARGF.read)	
+  END_CONF
+).gsub("  ","")
+       
+  File.open("#{ARGV[1]}/config/ruport.yaml", "w") { |f| f.puts(conf) }
+  File.open("#{ARGV[1]}/templates/test.rb", "w") { |f|
+    f.puts 'select "database()" do |r| puts r end'
+  }
+  exit
+elsif ARGV[0].eql?("-v")
+  puts "Ruport Version 0.2.0 \nA ruby report generation system by Gregory " +
+  "Brown.\nThis application is Free Software under the GPL/Ruby License. " +
+  "\nAll praise and/or criticism can be directed to "+
+  "gregory.t.brown@gmail.com"
+  exit
+end
+unless (File.exist?("config/ruport.yaml")) 
+  puts "You are trying to execute ruport from outside a ruport folder"
+  exit
 end
+config = YAML.load(File.open("config/ruport.yaml"))
+mailer = nil
 
+if config.has_key?(:mail_host)
+  mailer = Mailer.new( config[:mail_host],    config[:mail_address],
+                       config[:mail_account], config[:mail_password],
+                       25, config[:mail_authentication] )
+end
 
+report  = Report.new( 
+           "#{config[:driver]}:#{config[:database]}",
+           config[:db_user], config[:db_password], mailer )
 
+if config[:driver].eql?("ruport")
+  report = MockReport.new( "#{config[:driver]}:#{config[:database]}",
+           config[:db_user], config[:db_password], mailer )
+end
 
+report.query_table = config[:query_table]
+report.file = ARGV[1] unless ARGV[1].nil?
+unless ( File.exists? ARGV[0] ) 
+  report.logger.fatal("Could not open #{ARGV[0]}")
+  puts "Could not open #{ARGV[0]}"
+  exit
+end
+report.eval_report(ARGV[0], File.open(ARGV[0]) { |f| f.read })  
+report.generate_report if report.generate