railscheck 0.1.3 → 0.1.4

data/History.txt

@@ -1,10 +1,19 @@
-== 0.1.3 2008-03-15
+== 0.1.5 2008-yet to be releases
+* Adding javascript parse validation.
+* Adding preliminary ruby code parse validation.
+
+== 0.1.4 2008-04-26
+* Fix: sqlite3 compatibility.
+* Fix: changed check for plugin lib/init files to warnings.
+* Added test that has_many, has_one, belongs_to and has_and_belongs_to_many associations uses the correct pluralization for names.
+
+== 0.1.3 2008-04-15
 * Fixed typing mistake.
 
-== 0.1.2 2008-03-15
-* Included w3c_validators dependency in gem spec.
+== 0.1.2 2008-04-15
+* Included missing w3c_validators dependency in gem spec.
 
-== 0.1.1 2008-03-15
+== 0.1.1 2008-04-15
 * First proper beta
 
 == 0.1.0 2008-03-15
@@ -14,4 +23,4 @@
 * Internal release converted into a ruby gem (no longer a rails plugin)
 
 == 0.0.0 2008-03-03
-* Initial proof of concept prerelease as a rails plugin (as demoed at copenhagen.rb)
+* Initial proof of concept prerelease as a rails plugin (as demo'ed at copenhagen.rb)

data/Manifest.txt

@@ -11,11 +11,13 @@ config/requirements.rb
 lib/railscheck.rb
 lib/railscheck/testcase.rb
 lib/railscheck/version.rb
+lib/test/tc_associations.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
+lib/test/test_helper.rb
 log/debug.log
 script/console
 script/destroy

data/README.txt

@@ -126,10 +126,13 @@ information. See also my blog postings at "http://techblog.41concepts.com/" abou
 
 * ----> Submit your code additions and get your name added here!! <----
 
-INSPIRATION AND ATTRIBUTIONS:
+INSPIRATION, ATTRIBUTIONS AND SPECIAL CREDITS:
 * Fail Early Task written by Mike Naberezny for Advanced Rail Recipes.
 * DZone Snippet Rails task to find code typos in rhtml templates by "dseverin"
 
++ Aaron Patterson for the Johnson javascript gem, Ryan Davis for the ruby parser, 
+Alex Dunae for the W3C wrapper gem.
+
 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.txt file for details).

data/TODO.txt

@@ -5,8 +5,6 @@ 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
@@ -19,7 +17,7 @@ SHORT/MID TERM:
 * 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 
+* Code analysis checks of ruby and javascript code looking for, static detectable, 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.
 

data/config/hoe.rb

@@ -2,7 +2,7 @@ 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"
+DESCRIPTION = "Static verifier for Ruby On Rails 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"

data/lib/railscheck/testcase.rb

@@ -8,7 +8,30 @@ module Railscheck
      def default_test
        # Do nothing
      end
+          
+     protected
+     # Helper: Retrive array of all model classes in current rails project       
+     def lookup_active_record_models_classes
+      # Cache loaded model classes so we don't need to reload.
+      if !defined? @@model_classes
+        @@model_classes = []
+        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?')
+                @@model_classes << c
+             end
+           end
+        end
+      end
+
+      @@model_classes
+     end
      
+     # Helper: Handle warnings
      def warn(msg)
        puts "Warning: "+msg
      end

data/lib/railscheck/version.rb

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

data/lib/railscheck.rb

@@ -42,7 +42,8 @@ BANNER
            "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.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? }

data/lib/test/tc_associations.rb

@@ -0,0 +1,21 @@
+require 'test/test_helper'
+
+module Railscheck
+  module Test
+    class Associations < Railscheck::TestCase       
+      # Test that associations uses the correct pluralization.
+      def test_associations_pluralization
+        lookup_active_record_models_classes.each do |clazz|
+          clazz.reflect_on_all_associations.each do |a|
+            #puts "Checking associations #{a.macro} #{a.name} for #{clazz}"
+            if a.macro==:has_many || a.macro==:has_and_belongs_to_many 
+               assert plural?(a.name), "#{a.macro} association #{a.name} in model class #{clazz} should be be a plural name (as known by rails pluralizer)"
+            elsif a.macro==:has_one || a.macro==:belongs_to
+               assert singular?(a.name), "#{a.macro} association #{a.name} in model class #{clazz} should be be a singular name (as known by rails pluralizer)"                    
+            end
+          end
+        end
+     end
+    end
+  end
+end

data/lib/test/tc_config.rb

@@ -1,4 +1,4 @@
-require 'railscheck/testcase'
+require 'test/test_helper'
 
 module Railscheck
   module Test

data/lib/test/tc_database_models.rb

@@ -1,4 +1,4 @@
-require 'railscheck/testcase'
+require 'test/test_helper'
 
 module Railscheck
   module Test
@@ -7,9 +7,9 @@ module Railscheck
       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
+        assert_nothing_raised("Could not open database connection / no migration schema_info table in database") do
          ActiveRecord::Base.establish_connection
-         ActiveRecord::Base.connection.select_all('SHOW TABLES')
+         ActiveRecord::Base.connection.select_all('select * from schema_info')
         end
       end
       
@@ -25,16 +25,8 @@ module Railscheck
     
       # 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
+        lookup_active_record_models_classes.each do |clazz|
+          assert clazz.table_exists?, "Error - Could not find  database table #{clazz.table_name} corresponding to rails model #{clazz.name}"
         end
       end
 

data/lib/test/tc_html_and_css.rb

@@ -1,4 +1,4 @@
-require 'railscheck/testcase'
+require 'test/test_helper'
 require 'w3c_validators'
 
 module Railscheck

data/lib/test/tc_project.rb

@@ -1,4 +1,4 @@
-require 'railscheck/testcase'
+require 'test/test_helper'
 
 module Railscheck
   module Test
@@ -97,8 +97,8 @@ module Railscheck
           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}\""
+          warn "No lib sub-directory in plugin at \"#{plugindir}\"" if !File.directory?(lib_dir)          
+          warn "No init file in plugin at \"#{plugindir}\"" if !File.file?(init_file)
         end
       end
     end

data/lib/test/tc_views.rb

@@ -1,4 +1,4 @@
-require 'railscheck/testcase'
+require 'test/test_helper'
 
 module Railscheck
   module Test

data/lib/test/test_helper.rb

@@ -0,0 +1,19 @@
+require 'test/test_helper'
+require 'railscheck/testcase'
+
+# Read and return filename content as string.
+def get_file_as_string(filename)
+  File.open(filename, "r") { |f|
+      return f.read
+  }
+end
+
+# Helper: Checks if a string/symbol is pluralized.
+def plural?(str) 
+  str.to_s.pluralize==str.to_s 
+end    
+
+# Helper: Checks if a string/symbol is singularized.
+def singular?(str) 
+  str.to_s.singularize==str.to_s 
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: railscheck
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Morten M. Christensen / 41concepts
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-15 00:00:00 +02:00
+date: 2008-04-27 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,7 +21,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.9.2
     version: 
-description: Static verifier for rails 2.0+ projects
+description: Static verifier for Ruby On Rails projects
 email: 
 - mmc@41concepts.com
 executables: 
@@ -49,11 +49,13 @@ files:
 - lib/railscheck.rb
 - lib/railscheck/testcase.rb
 - lib/railscheck/version.rb
+- lib/test/tc_associations.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
+- lib/test/test_helper.rb
 - log/debug.log
 - script/console
 - script/destroy
@@ -92,7 +94,7 @@ rubyforge_project: railscheck
 rubygems_version: 1.1.1
 signing_key: 
 specification_version: 2
-summary: Static verifier for rails 2.0+ projects
+summary: Static verifier for Ruby On Rails projects
 test_files: 
 - test/test_helper.rb
 - test/test_railscheck.rb