ruby script/plugin install svn://rubyforge.org/var/svn/railscheck/trunk

RUNNING
============

First make sure this gem is installed, your project is configured and that all your migrations are run for the project(s) you want to check.

The gem contain "railscheck" executables for unix/linux/mac and windows. An alternative "jrailscheck" command is available for jruby users. The gem installation will place these executables on your PATH. Invoke the following command for more information.

   "railscheck -h"

Usage examples:
"railscheck -h" - to get detailed information about command options etc.
"railscheck" - to check rails project in current directory.
"railscheck path-to-your-rails-project" - to check the rails project at the specified path.
"railscheck -i database path-to-your-rails-project" - to run database checks for the rails project at the specified path.
"railscheck -x html" - to run every test but html related ones against rails project in current directory.

FEATURE SUMMARY
=================

SYNTAX CHECKS & VALIDATION (static files)
* Syntax check of static *.rb, *.rake and *.rjs ruby files (in test tc_syntax_check_ruby.rb)
* Syntax check of *.yaml files (in test tc_config.rb)
* Syntax check of *.xml files (in test tc_xml.rb)
* Syntax check of *.erb, *.rhtml view files (in test tc_views.rb)
* Syntax check (online) of *.css files (in tc_html_and_css.rb) currently using W3C web services.
* Syntax check (online) of *.(x)html files (in tc_html_and_css.rb) currently using W3C web services.

CHECK FOR RAILS PROJECT CONSISTENCY (in test tc_project.rb):
* Validates Ruby On Rails project structure and existence of key files necessary to develop, test and deploy rails projects successfully.

CHECK DATABASE (in test tc_database.rb):
* Checks that database is configured correct in project / ability to connect to database.
* Checks that database migration version corresponds to latest code migration version number in project.
* Checks that database drivers are fit for production use.
* Checks that test database does not overlap with development/production database.

CHECK MODELS (in test tc_models.rb):
* Validates that tables with correct names exist for all ActiveRecord model classes in project.
* Validates that has_many, has_one, belongs_to and has_and_belongs_to_many associations uses the correct pluralization for names (there are subtle problems with activerecord if this is not the case).

DEPRECATIONS (in test tc_rails_deprecations.rb)
* Warns if deprecated Rails constructs are used.

IN PROGRESS (NOT QUITE READY BUT DUE SOON):
* Syntax check of *.js javascript files (in test tc_javascript.rb)

There is currently no advanced documentation for this plugin.