rails_best_practices 0.2.6 → 0.2.8

data/README.textile

@@ -1,10 +1,17 @@
 h1. rails_best_practices
 
-rails_best_practices is a gem to check quality of rails app files according to ihower's presentation "Rails Best Practices":http://www.slideshare.net/ihower/rails-best-practices.
+rails_best_practices is a gem to check quality of rails app files according to ihower's presentation Rails Best Practices.
 rails_best_practices is a static file parser tool based on ruby_parser.
 
 *************************************************
 
+h2. Resources
+
+"ihower's presentation":http://www.slideshare.net/ihower/rails-best-practices
+"Wiki":http://wiki.github.com/flyerhzm/rails_best_practices
+
+*************************************************
+
 h2. Install
 
 <pre><code>

data/VERSION

@@ -1 +1 @@
-0.2.6
+0.2.8

data/lib/rails_best_practices/checks/always_add_db_index_check.rb

@@ -2,6 +2,12 @@ require 'rails_best_practices/checks/check'
 
 module RailsBestPractices
   module Checks
+    # Check a migration file to make sure every reference key has a database index.
+    #
+    # Implementation:
+    # Parse migration files twice.
+    # First, remember all reference keys and index keys.
+    # Second, compare reference keys and index keys, and add error when reference keys are not in index keys.
     class AlwaysAddDbIndexCheck < Check
 
       def interesting_nodes
@@ -30,6 +36,7 @@ module RailsBestPractices
         if @parse and :up == node.message
           @references.each do |table_name, column_names|
             differences = column_names - (@indexes[table_name] || [])
+            @references[table_name] = column_names - differences
             hint = differences.collect {|column_name| "#{table_name} => #{column_name}"}.join(', ')
             add_error "always add db index (#{hint})" unless differences.empty?
           end

data/lib/rails_best_practices/command.rb

@@ -36,6 +36,10 @@ options = {}
 OptionParser.new do |opts|
   opts.banner = "Usage: rails_best_practices [options]"
   
+  opts.on("-d", "--debug", "Debug mode") do
+    options['debug'] = true
+  end
+  
   opts.on_tail("-h", "--help", "Show this message") do
     puts opts
     exit
@@ -45,6 +49,7 @@ OptionParser.new do |opts|
 end
 
 runner = RailsBestPractices::Core::Runner.new
+runner.set_debug if options['debug']
 ignore_vendor_directories(add_duplicate_migration_files(expand_dirs_to_files(ARGV))).each { |file| runner.check_file(file) }
 runner.errors.each {|error| puts error}
 puts "\nFound #{runner.errors.size} errors."

data/lib/rails_best_practices/core/runner.rb

@@ -19,6 +19,11 @@ module RailsBestPractices
         @checks ||= load_checks
         @checker ||= CheckingVisitor.new(@checks)
         @parser = RubyParser.new
+        @debug = false
+      end
+      
+      def set_debug
+        @debug = true
       end
 
       def check(filename, content)
@@ -46,6 +51,7 @@ module RailsBestPractices
       private
 
       def parse(filename, content)
+        puts filename if @debug
         begin
           @parser.parse(content, filename)
         rescue Exception => e

data/rails_best_practices.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{rails_best_practices}
-  s.version = "0.2.6"
+  s.version = "0.2.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Huang"]
-  s.date = %q{2009-11-08}
+  s.date = %q{2009-11-09}
   s.default_executable = %q{rails_best_practices}
   s.description = %q{check rails files according to ihower's presentation 'rails best practices'}
   s.email = %q{flyerhzm@gmail.com}
@@ -80,23 +80,23 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{check rails files according to ihower's presentation 'rails best practices'}
   s.test_files = [
-    "spec/rails_best_practices/checks/use_scope_access_check_spec.rb",
-     "spec/rails_best_practices/checks/not_use_default_route_check_spec.rb",
-     "spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb",
-     "spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb",
-     "spec/rails_best_practices/checks/use_model_callback_check_spec.rb",
+    "spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb",
+     "spec/rails_best_practices/checks/always_add_db_index_check_spec.rb",
      "spec/rails_best_practices/checks/isolate_seed_data_check_spec.rb",
-     "spec/rails_best_practices/checks/many_to_many_collection_check_spec.rb",
-     "spec/rails_best_practices/checks/use_model_association_check_spec.rb",
-     "spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb",
+     "spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb",
      "spec/rails_best_practices/checks/law_of_demeter_check_spec.rb",
-     "spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb",
-     "spec/rails_best_practices/checks/nested_model_forms_check_spec.rb",
-     "spec/rails_best_practices/checks/use_observer_check_spec.rb",
+     "spec/rails_best_practices/checks/many_to_many_collection_check_spec.rb",
      "spec/rails_best_practices/checks/move_finder_to_named_scope_check_spec.rb",
+     "spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb",
      "spec/rails_best_practices/checks/needless_deep_nesting_check_spec.rb",
+     "spec/rails_best_practices/checks/nested_model_forms_check_spec.rb",
+     "spec/rails_best_practices/checks/not_use_default_route_check_spec.rb",
      "spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb",
-     "spec/rails_best_practices/checks/always_add_db_index_check_spec.rb",
+     "spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb",
+     "spec/rails_best_practices/checks/use_model_association_check_spec.rb",
+     "spec/rails_best_practices/checks/use_model_callback_check_spec.rb",
+     "spec/rails_best_practices/checks/use_observer_check_spec.rb",
+     "spec/rails_best_practices/checks/use_scope_access_check_spec.rb",
      "spec/spec_helper.rb"
   ]
 
@@ -116,4 +116,3 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<ruby2ruby>, [">= 0"])
   end
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rails_best_practices
 version: !ruby/object:Gem::Version 
-  version: 0.2.6
+  version: 0.2.8
 platform: ruby
 authors: 
 - Richard Huang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-08 00:00:00 +08:00
+date: 2009-11-09 00:00:00 +08:00
 default_executable: rails_best_practices
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -125,21 +125,21 @@ signing_key:
 specification_version: 3
 summary: check rails files according to ihower's presentation 'rails best practices'
 test_files: 
-- spec/rails_best_practices/checks/use_scope_access_check_spec.rb
-- spec/rails_best_practices/checks/not_use_default_route_check_spec.rb
 - spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb
-- spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb
-- spec/rails_best_practices/checks/use_model_callback_check_spec.rb
+- spec/rails_best_practices/checks/always_add_db_index_check_spec.rb
 - spec/rails_best_practices/checks/isolate_seed_data_check_spec.rb
-- spec/rails_best_practices/checks/many_to_many_collection_check_spec.rb
-- spec/rails_best_practices/checks/use_model_association_check_spec.rb
-- spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb
+- spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb
 - spec/rails_best_practices/checks/law_of_demeter_check_spec.rb
-- spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb
-- spec/rails_best_practices/checks/nested_model_forms_check_spec.rb
-- spec/rails_best_practices/checks/use_observer_check_spec.rb
+- spec/rails_best_practices/checks/many_to_many_collection_check_spec.rb
 - spec/rails_best_practices/checks/move_finder_to_named_scope_check_spec.rb
+- spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb
 - spec/rails_best_practices/checks/needless_deep_nesting_check_spec.rb
+- spec/rails_best_practices/checks/nested_model_forms_check_spec.rb
+- spec/rails_best_practices/checks/not_use_default_route_check_spec.rb
 - spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb
-- spec/rails_best_practices/checks/always_add_db_index_check_spec.rb
+- spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb
+- spec/rails_best_practices/checks/use_model_association_check_spec.rb
+- spec/rails_best_practices/checks/use_model_callback_check_spec.rb
+- spec/rails_best_practices/checks/use_observer_check_spec.rb
+- spec/rails_best_practices/checks/use_scope_access_check_spec.rb
 - spec/spec_helper.rb