railscheck 0.1.0 → 0.1.1

data/Manifest.txt

@@ -5,9 +5,7 @@ README.txt
 Rakefile
 TODO.txt
 bin/jrailscheck
-bin/jrailscheck.bat
 bin/railscheck
-bin/railscheck.bat
 config/hoe.rb
 config/requirements.rb
 lib/railscheck.rb

data/README.txt

@@ -2,9 +2,9 @@
 
 == 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.
+This projects is (or will be) 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
@@ -19,94 +19,108 @@ 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.
+this gem.
 
 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
+== STATUS
+
+This project is a working beta. It works and is useful but has a very limited feature set. Much more to come. Use the rubyforge tracker function on the railscheck website to suggest features that you would like to be added (or bugs to fix)
+
+== INSTALLATION
 
 This project is hosted on rubyforge. Install latest version using:
 
   "sudo gem install railscheck"
 
-== Running
+== 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 installation will place railscheck executables on path. Invoke the following command for more information.
+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"
 
-The gem contain executables for unix/linux/mac and windows. An alternative "jrailscheck" command is available for jruby
-users.
+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. 
 
-== Features
+== FEATURE SUMMARY
 
-Project:
+Project (in test tc_project.rb):
 * Check validity of Ruby On Rails project structure and existence of key files necessary to
   develop, test and deploy rails projects successfully. 
   
-Configuration files:
+Configuration files (in test tc_config.rb):
 * Syntax check of all YAML configuration files in project
 
-Views:
+Views (in test tc_views.rb):
 * Syntax check of all ERB configuration files in project
 
-(X)HTML/CSS:
+(X)HTML/CSS (in test tc_htl_and_css.rb):
 * 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:
+Database (in test tc_database_models.rb):
 * 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
+== PROJECT SITE AND DOCUMENTATION 
 
+See "http://rubyforge.org/projects/railscheck/" for sourceforge project site.
+See "http://railscheck.rubyforge.org/" for project intro page.
 See "http://railscheck.rubyforge.org/rdoc/" for project RDOC.
 
-== Warnings and limitations
++ visit "http://techblog.41concepts.com/" for blog postings about railscheck as well as other software R&D subjects.
 
-This plugin assumes that normally safe code in rails projects such as enviroment.rb, intializers, yaml, 
+== WARNINGS AND LIMITATIONS
+
+This project 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).
+This project does generally not check dynamic behavior of the application and can as such not replace good testing
+practices, unit-testing etc. Nor does this project (currently) test documentation and vendor plugins. The gem is
+targeted for Rails v1.0+ running on Ruby 1.8.6+ / RubyGems 1.1 compliant implementations (no work will be done to ensure
+compatibility with older Rails/ruby/gem versions). Some tests may require later versions of rails such as Rails v2.0+
 
-== Contributing
+== KNOWN BUGS
 
-Any contributions to checks that can be added are welcomed. Please contact undersigned for details.
+- The jrailscheck.bat file generated by rubygems on windows invoke ruby instead of jruby. Users have to manually change the bat file installed in the ruby bin directory until I find out how to make rubygem behave correctly here.
 
-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.
+== CONTRIBUTING
 
-== Support
+Any contributions to tests etc. that can be added are welcomed. Please contact undersigned for details.
 
-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.
+Any added code 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 project.
 
-== Examples
+== SUPPORT
 
-Make sure this plugin is installed and that all your migrations are run. T
+There is no formal support for this project. Please use railscheck.rubyforge.org to report problems/suggestions and I will look at them in time.
 
-"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, ATTRIBUTIONS AND AUTHOR INFORMATION
 
 Copyright (c) 2008 Morten Christensen, 41concepts (www.41concepts.com), Denmark
 
-Authors:
+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.
+information. See also my blog postings at "http://techblog.41concepts.com/" about Railscheck as well as other software R&D subjects.
+
+* ----> Submit your code additions and get your name added here!! <----
 
-Inspirations and attributions:
+INSPIRATION 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"
 
+LICENSE INFORMATION:
 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).
+software development tool makers that require a license (see License.txt file for details).

data/lib/railscheck/version.rb

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

data/tasks/deployment.rake

@@ -7,8 +7,8 @@ task :deploy => [:check_version, :website, :release] do
   puts "Tagging release #{CHANGES}"
 end
 
-desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
-task :local_deploy => [:website_generate, :install_gem]
+desc 'Runs tasks install_gem as a local deployment of the gem'
+task :local_deploy => [:install_gem]
 
 task :check_version do
   unless ENV['VERSION']

data/website/index.html

@@ -2,17 +2,24 @@
 <body>
 <h1>Railscheck - The semi-static Q/A verification tool for your Ruby on Rails projects</h1>
 
-<p>This project is a best effort semi-static verifier for your <a href="http://www.rubyonrails.com/">Ruby on Rails</a> 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.</p>
+<p>This project is (or will be) a best effort semi-static verifier for your <a href="http://www.rubyonrails.com/">Ruby on Rails</a> 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. See <a href="http://railscheck.rubyforge.org/svn/trunk/README.txt"><b>here</b></a> for more information.</p>
+
+<h2>Installation</h2>
+<p>Install latest version using: "<b>sudo gem install railscheck</b>"</p>
+
+<h2>Running</h2>
+<p>The installation will place railscheck executables on your PATH. Invoke the following command for usage help: "<b>railscheck -h</b>" </p>
+<p><i>Note: First do 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. See <a href="http://railscheck.rubyforge.org/svn/trunk/README.txt"><b>here</b></a> for more information.</i></p>
 
 <h2>Project site and more information</h2>
-<p>This project is hosted on <a href="http://rubyforge.org/projects/railscheck/">rubyforge.org</a>. Refer to the latest <a href="http://railscheck.rubyforge.org/svn/trunk/README.txt">README</a> for up-to-date information on the plugin including how to use and install it.</p>
+<p>This project is hosted on <a href="http://rubyforge.org/projects/railscheck/">http://rubyforge.org/projects/railscheck/</a>. Refer to the latest <a href="http://railscheck.rubyforge.org/svn/trunk/README.txt"><b>README</b></a> for up-to-date information on the plugin.</p>
 <p/>
-<h2>About the author(s):</h2>
+<h2>Authors</h2>
 <ol>
 <li><a href="http://workingwithrails.com/person/4802-morten-m-christensen">Morten Christensen</a>, senior consultant, software developer from Danish software development/consultancy company <a href="http://www.41concepts.com">41concepts</a></li>
 </ol>
 <h2>License:</h2>
 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 project <a href="http://railscheck.rubyforge.org/svn/trunk/License.txt">license file</a> for details).
+software development tool makers that require a license (see project <a href="http://railscheck.rubyforge.org/svn/trunk/License.txt"><b>license file</b></a> for details).
 </body>
 </html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: railscheck
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Morten M. Christensen / 41concepts
@@ -18,9 +18,7 @@ email:
 - mmc@41concepts.com
 executables: 
 - jrailscheck
-- jrailscheck.bat
 - railscheck
-- railscheck.bat
 extensions: []
 
 extra_rdoc_files: 
@@ -37,9 +35,7 @@ files:
 - Rakefile
 - TODO.txt
 - bin/jrailscheck
-- bin/jrailscheck.bat
 - bin/railscheck
-- bin/railscheck.bat
 - config/hoe.rb
 - config/requirements.rb
 - lib/railscheck.rb
@@ -85,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: railscheck
-rubygems_version: 1.1.0
+rubygems_version: 1.1.1
 signing_key: 
 specification_version: 2
 summary: Static verifier for rails 2.0+ projects

data/bin/jrailscheck.bat

@@ -1,3 +0,0 @@
-@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.bat

@@ -1,3 +0,0 @@
-@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