railscheck 0.1.0

data/History.txt

@@ -0,0 +1,7 @@
+== 0.0.1 2008-03-03
+* Initial proof of concept prerelease as a rails plugin.
+
+== 0.0.1 2008-04-13
+
+* First proper release as a ruby gem (no longer a rails plugin)
+

data/License.txt

@@ -0,0 +1,27 @@
+Copyright (c) 2008 Morten Christensen (mmc[AT/NOSPAM]41concepts[dot]com), 41concepts Aps (www.41concepts.com), Denmark
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to use, copy, modify, merge, include, publish,
+distribute this software ... with the single following
+restriction for commercial software development tool makers:
+
+- You may not sell a commercial software development tool that includes 
+  this software without permission from the copyright holder of this 
+  software (note: restriction does not apply to free software tools).
+  This permission usually involves paying a small fee or making
+  a contribution to the project.
+   
+Furthermore your permission to use this software is subject to
+the following conditions:
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.

data/Manifest.txt

@@ -0,0 +1,32 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+TODO.txt
+bin/jrailscheck
+bin/jrailscheck.bat
+bin/railscheck
+bin/railscheck.bat
+config/hoe.rb
+config/requirements.rb
+lib/railscheck.rb
+lib/railscheck/testcase.rb
+lib/railscheck/version.rb
+lib/test/tc_config.rb
+lib/test/tc_database_models.rb
+lib/test/tc_html_and_css.rb
+lib/test/tc_project.rb
+lib/test/tc_views.rb
+log/debug.log
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+test/test_railscheck.rb
+website/index.html

data/README.txt

@@ -0,0 +1,112 @@
+= Railscheck - The semi-static Q/A verification tool for your Ruby on Rails projects!
+
+== DESCRIPTION
+
+This project is a best effort semi-static verifier for your Ruby on Rails projects. Delivered as a Ruby gem it 
+provides a shell command task "railscheck" that you can run against your Rails projects to test for a number of 
+typical bugs and inconsistencies.
+
+It is a law of software development that the earlier you identify a problem the cheaper it is to fix. This project
+aims to help you quickly identify many bugs and inconsistencies as early as possible (thus avoiding unnecessary
+debugging work for you and your development team ; as well as avoiding unnecessary, negative "surprises" for your users).
+
+Typical ruby/rails development tools does not provide ANY kind of static verification checks since the problem
+appears to be just about unsolvable in the general case (because of the dynamic nature of Ruby). However for a 
+strictly limited domain such as Rails Web Applications, there are actually many potential bugs that can be 
+identified statically, or at least (semi-)statically, without having to start the web server and actually
+run the application.
+
+Furthermore because of the opinionated nature of Rails, there are many conventions that can be broken and that we can 
+check for. Finally rails projects depends on much more than just ruby code - i.e. migrations, database schemas, erb, html,
+css, yaml etc... All of which needs to work for an application to fully function and which is therefore in the scope of this
+this plugin.
+
+However, this project can not - and does not attempt to - find all logical/programming errors. As such the gem 
+supplements and does not replace existing testing practices such as automated rails tests.
+
+== Installation
+
+This project is hosted on rubyforge. Install latest version using:
+
+  "sudo gem install railscheck"
+
+== Running
+
+The installation will place railscheck executables on path. Invoke the following command for more information.
+
+   "railscheck -h"
+
+The gem contain executables for unix/linux/mac and windows. An alternative "jrailscheck" command is available for jruby
+users.
+
+== Features
+
+Project:
+* Check validity of Ruby On Rails project structure and existence of key files necessary to
+  develop, test and deploy rails projects successfully. 
+  
+Configuration files:
+* Syntax check of all YAML configuration files in project
+
+Views:
+* Syntax check of all ERB configuration files in project
+
+(X)HTML/CSS:
+* Validation check of all static XHTML/HTML files in project (currently using W3C web services).
+* Validation check of all static CSS files in project (currently using W3C web services).
+
+Database:
+* Validates that database is configured correct in project / ability to connect to database.
+* Validates that database migration version corresponds to latest code migration version number in project.
+* Validates that tables with correct names exist for all ActiveRecord model classes in project. 
+
+== Documentation
+
+See "http://railscheck.rubyforge.org/rdoc/" for project RDOC.
+
+== Warnings and limitations
+
+This plugin assumes that normally safe code in rails projects such as enviroment.rb, intializers, yaml, 
+views, models etc. do NOT have dangerous (insane) side-effects that happen just by Ruby loading the 
+source file or Ruby retrieving state of objects. If you ever encounter such a bizarre rails project, which
+is extremely unlikely, do NOT run railscheck on the project (and be very, very careful in general about 
+what you are doing with the project).
+
+This plugin does generally not check dynamic behavior of the application and can as such not replace good testing
+practices, unit-testing etc. Nor does this plugin (currently) test documentation and plugins. The gem is
+targeted for Rails v1.0+ running on Ruby 1.8.6+ compliant implementations (no work will be done to ensure
+compatibility with older rails/ruby versions).
+
+== Contributing
+
+Any contributions to checks that can be added are welcomed. Please contact undersigned for details.
+
+Any added checks that you contribute will be given due credit. However make sure that you assign undersigned
+shared copyright so that I am allowed to release and license your work together with this plugin.
+
+== Support
+
+There is no formal support for this plugin. Please use railscheck.rubyforge.org to report problems/suggestions and I will look at them in time.
+
+== Examples
+
+Make sure this plugin is installed and that all your migrations are run. T
+
+"railscheck" - to check rails project in current directory.
+"railscheck path-to-your-rails-project" - to check the rails project at the specified path.
+
+== Copyrights, Attributions and Author information
+
+Copyright (c) 2008 Morten Christensen, 41concepts (www.41concepts.com), Denmark
+
+Authors:
+* Morten Christensen, am a software developer from the Danish software company 41concepts (www.41concepts.com). We do
+Ruby/Rails/Java/.NET software development consultancy. Contact me at mmc[AT/NOSPAM]41concepts[dot]com for more 
+information.
+
+Inspirations and attributions:
+* Fail Early Task written by Mike Naberezny for Advanced Rail Recipes.
+* DZone Snippet Rails task to find code typos in rhtml templates by "dseverin"
+
+This software is FREE for both public and commercial use - with the possible exception of commercial
+software development tool makers that require a license (see license file for details).

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/TODO.txt

@@ -0,0 +1,27 @@
+TODO
+=======
+
+See below for a list of some future checks that are considered:
+ 
+SHORT/MID TERM:
+
+* Verify javascript
+* Syntax check where possible of *.rb
+* Syntax check *.rjs
+* Verify other markup than erb.
+* Additional verification of migration files
+* Syntax check project rake files.
+* Verify *.cgi files.
+* Verify process and script files.
+* Shallow verification of known rails "declarations" such as before_filters, belongs_to etc.
+* Verify integrity of database-related YAML (test) fixtures (corresponding to table columns and all).
+* Compare model constrains against database constrains. 
+* Check (some) model validations against data in database (looking for illegal data in database).
+
+LONGER TERM:
+* Code analysis checks of ruby and javascriprt code looking for, static detectablable, ruby code 
+  that may have "simple" errors like accessing a variable before it is declared etc. This
+  may in turn open up for many more features.
+
+
+Copyright (c) 2008 Morten Christensen (mmc[AT/NOSPAM]41concepts[dot]com), 41concepts Aps (www.41concepts.com), Denmark

data/bin/jrailscheck

@@ -0,0 +1,3 @@
+#!/usr/bin/env jruby
+#  Copyright (c) 2008. Morten M. Christensen, 41concepts Aps. All rights reserved.
+require File.dirname(__FILE__) + '/../lib/railscheck'

data/bin/jrailscheck.bat

@@ -0,0 +1,3 @@
+@ECHO OFF
+REM #  Copyright (c) 2008. Morten M. Christensen, 41concepts Aps. All rights reserved.
+jruby.exe ../lib/railscheck.rb %1 %2 %3 %4 %5 %6 %7 %8 %9

data/bin/railscheck

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+#  Copyright (c) 2008. Morten M. Christensen, 41concepts Aps. All rights reserved.
+require File.dirname(__FILE__) + '/../lib/railscheck'

data/bin/railscheck.bat

@@ -0,0 +1,3 @@
+@ECHO OFF
+REM #  Copyright (c) 2008. Morten M. Christensen, 41concepts Aps. All rights reserved.
+ruby.exe ../lib/railscheck.rb %1 %2 %3 %4 %5 %6 %7 %8 %9

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'railscheck/version'
+
+AUTHOR = 'Morten M. Christensen / 41concepts'  # can also be an array of Authors
+EMAIL = "mmc@41concepts.com"
+DESCRIPTION = "Static verifier for rails 2.0+ projects"
+GEM_NAME = 'railscheck' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'railscheck' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "mmc"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Railscheck::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'railscheck documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/railscheck/testcase.rb

@@ -0,0 +1,16 @@
+require 'test/unit'
+
+# Base class for all testcases in railscheck. Put all general behavior for Railscheck
+# testcases here.
+module Railscheck
+  class TestCase < ::Test::Unit::TestCase
+     # Redefine defqult_test so we don't get any errors about missing test in our base class.
+     def default_test
+       # Do nothing
+     end
+     
+     def warn(msg)
+       puts "Warning: "+msg
+     end
+  end
+end

data/lib/railscheck/version.rb

@@ -0,0 +1,9 @@
+module Railscheck #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/railscheck.rb

@@ -0,0 +1,93 @@
+begin
+  require 'rubygems'
+rescue LoadError
+  # no rubygems to load, so we fail silently
+end
+
+require 'optparse'
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'railscheck/version'
+
+module Railscheck
+  puts "Railscheck "+Railscheck::VERSION::STRING+" (nb. help & more information avilable with -h argument):"
+
+  OPTIONS = {
+    :include_test_files     => '.*',
+    :exclude_test_files     => ''
+  }
+  MANDATORY_OPTIONS = %w(  )
+
+  parser = OptionParser.new do |opts|
+opts.banner = <<BANNER
+  This gem is a best effort semi-static verifier for your Ruby on Rails projects
+  freely provided as an open source project by 41concepts (www.41concepts.com).
+
+  Usage: #{File.basename($0)} [options] [rails-project-path]
+
+  Defailt behavior is run all tests against the the rails project in the current directory (if no arguments are provided).
+
+  See \"http://railscheck.rubyforge.org\" for more information. 
+
+  Optional options are:
+BANNER
+  
+    opts.separator ""
+    opts.on("-i", "--include_test_files=txt", String,
+            "Only include test files satisfying specified the regular expresssion string (without //)"
+           ) { |OPTIONS[:include_test_files]| }
+           
+    opts.on("-x", "--exclude_test_files=txt", String,
+           "Exclude test files satisfying specified the regular expresssion string (without //)"
+           ) { |OPTIONS[:exclude_test_files]| }
+
+    opts.on("-h", "--help", "Show this help message.") { puts opts; exit }
+    opts.parse!(ARGV)
+
+    if MANDATORY_OPTIONS && MANDATORY_OPTIONS.find { |option| OPTIONS[option.to_sym].nil? }
+      puts opts; exit
+    end
+  end
+
+  has_project_dir_arg = (ARGV.length>0)
+  railscheck_root_dir = has_project_dir_arg ? ARGV[0] : '.' # Use first non-option argument at root
+
+  puts "No directory provided. Using '"+railscheck_root_dir+"'" if !has_project_dir_arg
+
+  begin
+   require "#{railscheck_root_dir}/config/boot"
+   require 'environment'
+  rescue LoadError => e
+   puts "Could not locate RoR project at \"#{railscheck_root_dir}\"."
+   exit (-1)
+  end
+
+  puts "Booted RoR #{Rails::VERSION::STRING} project at \"#{RAILS_ROOT}\"."
+  puts "Running all railscheck tests satifying /#{OPTIONS[:include_test_files]}/  " + (OPTIONS[:exclude_test_files].empty? ? ":" : "and not satifying /#{OPTIONS[:exclude_test_files]}/:" )
+
+  # Get all test files from test folder and apply include/exclude filters.
+  tests = []
+  Dir[File.join(File.dirname(__FILE__), "test/tc_*.rb")].each do |tstfile|
+   tst_basename = File.basename(tstfile)
+   tests << tstfile if (tst_basename =~ Regexp.new(OPTIONS[:include_test_files])) and (OPTIONS[:exclude_test_files].empty? || !(tst_basename =~ Regexp.new(OPTIONS[:exclude_test_files])))
+  end
+
+  require 'test/unit/testsuite'
+  
+  #test_suite = Test::Unit::TestSuite.new("Railscheck testsuite")
+  #tests.sort.each do |tst|
+  #  puts "Loading test file \"#{tst}\"."
+  #  test_suite << require(tst).suite
+  #end
+  #require 'test/unit/ui/console/testrunner'
+  #::Test::Unit::UI::Console::TestRunner.run(test_suite)
+
+  # Run all tests in sorted order.  
+  tests.sort.each do |tst|
+   puts "Loading test file \"#{tst}\"."
+   require tst
+  end
+ 
+  require 'test/unit/ui/console/testrunner'
+end # module Railscheck

data/lib/test/tc_config.rb

@@ -0,0 +1,16 @@
+require 'railscheck/testcase'
+
+module Railscheck
+  module Test
+    class Config < Railscheck::TestCase
+      # Test that every yaml file in the project can parse (except vendor plugins/rails).
+      def test_all_yaml_can_parse  
+        (Dir["#{RAILS_ROOT}/**/*.yml"]-Dir["#{RAILS_ROOT}/vendor/**/*.yml"]).each do |fname|
+          assert_nothing_raised("Could not parse file \"#{fname}\".") do
+            raise StandardError.new("Parse failed") if YAML.parse_file(fname)==nil
+          end
+        end
+      end 
+    end
+  end
+end

data/lib/test/tc_database_models.rb

@@ -0,0 +1,43 @@
+require 'railscheck/testcase'
+
+module Railscheck
+  module Test
+    class DataBaseModels < Railscheck::TestCase 
+      # Test that database connection can be established.
+      def test_database_connection_working
+        assert File.file?("#{RAILS_ROOT}/config/database.yml"), "Database configuration file database.yml must be present"
+        
+        assert_nothing_raised("Could not open database connection") do
+         ActiveRecord::Base.establish_connection
+         ActiveRecord::Base.connection.select_all('SHOW TABLES')
+        end
+      end
+      
+      # Test that all migrations has been migrated.
+      def test_database_consistent_with_migration_version
+         db_version =  ActiveRecord::Migrator.current_version rescue 0
+         highest_migration_version_in_project = Dir.glob("#{RAILS_ROOT}/db/migrate/*.rb" ).map { |f|
+           f.match(/(\d+)_.*\.rb$/) ? $1.to_i : 0
+          }.max
+          
+         assert_equal highest_migration_version_in_project, db_version, "Database version is not up-to-date with migrations (forgot to run db:migrate?)."
+      end
+    
+      # Check that correctly named database tables exist for each rails model
+      def test_database_tables_and_models_consistency      
+        Dir["#{RAILS_ROOT}/app/models/*rb"].each do |fname|
+          class_names = load(fname, false)
+          class_names.each do |class_name|
+            c = Object.const_get(class_name)
+            # Note: "c.kind_of?(ActiveRecord::Base)" not working here so do alt. check instead.
+            if (c.respond_to? 'abstract_class') && !c.abstract_class? &&
+               (c.respond_to? 'descends_from_active_record?') #&& c.descends_from_active_record?
+              assert c.table_exists?, "Error - Could not find  database table #{c.table_name} corresponding to rails model #{c.name}"
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/test/tc_html_and_css.rb

@@ -0,0 +1,55 @@
+require 'railscheck/testcase'
+require 'w3c_validators'
+
+module Railscheck
+  module Test
+    class HtmlAndCss < Railscheck::TestCase
+      include W3CValidators
+      
+      MAX_VALIDATION_ERRORS = 3 # Filter for how many errors to show.
+      MAX_VALIDATION_WARNINGS = 3 # Filter for how many warnings to show.
+
+      # Test that static CSS files validates using W3C online service.
+      def test_all_css_validates
+        @validator = CSSValidator.new
+           
+        Dir["#{RAILS_ROOT}/public/**/*.css", "#{RAILS_ROOT}/doc/**/*.css"].each do |fname|
+          results = @validator.validate_file(fname)
+          
+          validation_errors = results.errors.length
+          validation_errors_to_show = [results.errors.length, MAX_VALIDATION_ERRORS].min
+          
+          validation_warnings = results.warnings.length
+          validation_warnings_to_show = [results.warnings.length, MAX_VALIDATION_WARNINGS].min
+          
+          assert_equal 0, results.errors.length, "#{validation_errors} validation error(s) in \"#{fname}\". Showing #{validation_errors_to_show}: "+results.errors[0..validation_errors_to_show-1].join("\n")
+          
+          if (validation_warnings!=0)
+           warn "#{validation_warnings} validation warning(s) in \"#{fname}\". Showing #{validation_warnings_to_show}: "+results.warnings[0..validation_warnings_to_show-1].join("\n")
+          end
+        end
+      end 
+      
+      # Test that static HTML files validates using W3C online service.
+      def test_all_html_validates
+        @validator = MarkupValidator.new
+           
+        Dir["#{RAILS_ROOT}/public/**/*.html", "#{RAILS_ROOT}/public/**/*.xhtml", "#{RAILS_ROOT}/doc/**/*.html", "#{RAILS_ROOT}/doc/**/*.xhtml"].each do |fname|
+          results = @validator.validate_file(fname)
+          
+          validation_errors = results.errors.length
+          validation_errors_to_show = [results.errors.length, MAX_VALIDATION_ERRORS].min
+          
+          validation_warnings = results.warnings.length
+          validation_warnings_to_show = [results.warnings.length, MAX_VALIDATION_WARNINGS].min
+          
+          assert_equal 0, results.errors.length, "#{validation_errors} validation error(s) in \"#{fname}\". Showing #{validation_errors_to_show}: "+results.errors[0..validation_errors_to_show-1].join("\n")
+          
+          if (validation_warnings!=0)
+           warn "#{validation_warnings} validation warning(s) in \"#{fname}\". Showing #{validation_warnings_to_show}: "+results.warnings[0..validation_warnings_to_show-1].join("\n")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/test/tc_project.rb

@@ -0,0 +1,106 @@
+require 'railscheck/testcase'
+
+module Railscheck
+  module Test
+    class Project < Railscheck::TestCase
+      # Verify rails project structure/files taking into account various rails versions, build-in test/rspec usage etc.
+      def test_rails_project
+         root = RAILS_ROOT
+        
+         # Check for key rails 1.0+ directories that must exist for all complete and valid projects (skip optional ones):
+         ["#{root}/app", "#{root}/app/controllers", "#{root}/app/helpers", "#{root}/app/models", "#{root}/app/views", "#{root}/app/views/layouts",
+          "#{root}/config", "#{root}/config/environments",
+          "#{root}/db", 
+          "#{root}/lib", "#{root}/lib/tasks",
+          "#{root}/log", 
+          "#{root}/public", "#{root}/public/images", "#{root}/public/javascripts","#{root}/public/stylesheets",
+          "#{root}/script", "#{root}/script/performance", "#{root}/script/process",
+          "#{root}/vendor", "#{root}/vendor/plugins"
+         ].each do |dir|
+          assert File.directory?(dir), "Error - missing rails directory #{dir}"
+         end
+         
+         # Check for key rails 2.0+ directories that must exist for all complete and valid projects (skip optional ones):
+         if Rails::VERSION::MAJOR >=2
+           ["#{root}/config/initializers"
+           ].each do |dir|
+             assert File.directory?(dir), "Error - missing rails directory #{dir}"
+           end
+         end
+         
+         # Build-in test or rspec can be used so we need to verify which one (or both) is used.
+         test = File.directory?("#{root}/test")
+         rspec = File.directory?("#{root}/spec")
+         
+         # Check that build-in test or rspec test directories exist.
+         assert test || rspec, "Either test or spec directories should exist for testing purposes. Both are missing."
+         
+         # Check for build-in test directories (may not all exist so issue warnings only)
+         if test
+          ["#{root}/test/fixtures", "#{root}/test/functional", "#{root}/test/integration", 
+           "#{root}/test/mocks", "#{root}/test/mocks/development", "#{root}/test/mocks/test",
+          ].each do |dir|
+            "Missing rails directory #{dir}" if !File.directory?(dir)
+          end
+         end
+
+         # Check for rspec directories (may not all exist so issue warnings only)       
+         if rspec
+          [ #TODO: Add any expected directories here.
+          ].each do |dir|
+            "Missing rails rspec directory #{dir}" if !File.directory?(dir)
+          end
+         end
+
+         # Check for vital rails 1.0+ files that must exist for all complete and valid projects (skip optional ones):
+         ["#{root}/app/controllers/application.rb",
+          "#{root}/config/boot.rb", "#{root}/config/database.yml", "#{root}/config/environment.rb", "#{root}/config/routes.rb",
+          "#{root}/config/environments/development.rb", "#{root}/config/environments/test.rb", "#{root}/config/environments/production.rb",
+          "#{root}/script/about", "#{root}/script/console", "#{root}/script/console", "#{root}/script/destroy", "#{root}/script/generate",
+          "#{root}/script/plugin", "#{root}/script/runner", "#{root}/script/server",
+          "#{root}/script/performance/benchmarker", "#{root}/script/performance/profiler",
+          "#{root}/script/process/inspector", "#{root}/script/process/reaper", "#{root}/script/process/spawner",
+         ].each do |file|
+          assert File.file?(file), "Error - missing rails file #{file}"
+        end
+        
+         # Check for vital rails 2.0+ files that must exist for all complete and valid projects (skip optional ones):
+         if Rails::VERSION::MAJOR >=2
+           [ #TODO: Add any rails 2.x only files here
+           ].each do |file|
+            assert File.file?(file), "Error - missing rails file #{file}"
+          end
+        end
+        
+        # Check for optional build-in test files.        
+        if test
+           ["#{root}/test/test_helper.rb"
+           ].each do |file|
+            warn "Missing rails file #{file}" if !File.file?(file) 
+          end
+        end
+        
+        # Check for optional rspec files.        
+        if rspec
+           ["#{root}/spec/spec_helper.rb"
+           ].each do |file|
+            warn "Missing rails rspec file #{file}" if !File.file?(file)
+          end
+        end
+      end # test_rails_project
+
+      # test that installed plugins have the required minimum file structure.      
+      def test_plugins_valid
+        Dir["#{RAILS_ROOT}/vendor/plugins/*"].each do |plugindir|
+          assert File.directory?(plugindir), "Error - \"#{plugindir}\" is not a directory. Project vendor directory may only contain directories."
+          
+          lib_dir = File.join(plugindir, "lib")
+          init_file = File.join(plugindir, "init.rb")
+          
+          assert File.directory?(lib_dir), "Error no lib sub-directory in plugin at \"#{plugindir}\""
+          assert File.file?(init_file), "Error no init file in plugin at \"#{plugindir}\""
+        end
+      end
+    end
+  end
+end