rails_best_practices 0.3.3 → 0.3.4

data/README.textile

@@ -22,7 +22,7 @@ sudo gem install rails_best_practices --source http://gemcutter.org
 
 h2. Usage
 
-at the root directory of rails app
+At the root directory of rails app
 
 <pre><code>
 rails_best_practices .
@@ -45,6 +45,18 @@ Usage: rails_best_practices [options]
 
 *************************************************
 
+h2. Issue
+
+If you got NoMethodError or any syntax error, you should use debug mode to detect which file rails_best_practices is parsing and getting the error.
+
+<pre><code>
+rails_best_practices -d .
+</code></pre>
+
+Then give me the error stack and the source code of the file that rails_best_practices is parsing error.
+
+*************************************************
+
 h2. Customize Configuration
 
 Copy <code>rails_best_practices.yml</code> in the root directory of rails_best_practices gem to <code>config</code> directory

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

data/lib/rails_best_practices/checks/always_add_db_index_check.rb

@@ -21,11 +21,15 @@ module RailsBestPractices
       def initialize
         super
         @files = []
-        @references = {}
-        @indexes = {}
+        @@indexes = {}
         @parse = false
       end
 
+      # make indexes class method for get indexes out of AlwaysAddDbIndexCheck class.
+      def self.indexes
+        @@indexes
+      end
+
       def evaluate_start(node)
         if @files.include? node.file
           @parse = true if :up == node.message
@@ -34,57 +38,63 @@ module RailsBestPractices
         end
 
         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
+          check_references(node.body)
         else
-          remember_references(node.body)
           remember_indexes(node.body)
         end
       end
 
       private
 
-      def remember_references(node)
+      def check_references(node)
         create_table_node = node.grep_nodes({:node_type => :call, :message => :create_table}).first
         if create_table_node
           table_name = create_table_node.arguments[1].to_ruby_string
           node.grep_nodes({:node_type => :call, :message => :integer}).each do |integer_node|
             column_name = integer_node.arguments[1].to_ruby_string
-            if column_name =~ /_id$/
-              @references[table_name] ||= []
-              @references[table_name] << column_name
+            if column_name =~ /_id$/ and !@@indexes[table_name].include? column_name
+              add_error "always add db index (#{table_name} => #{column_name})"
             end
           end
           node.grep_nodes({:node_type => :call, :message => :references}).each do |references_node|
             column_name = references_node.arguments[1].to_ruby_string + "_id"
-            @references[table_name] ||= []
-            @references[table_name] << column_name
+            if !@@indexes[table_name].include? column_name
+              add_error "always add db index (#{table_name} => #{column_name})"
+            end
           end
           node.grep_nodes({:node_type => :call, :message => :column}).each do |column_node|
             if 'integer' == column_node.arguments[2].to_ruby_string
               column_name = column_node.arguments[1].to_ruby_string
-              if column_name =~ /_id$/
-                @references[table_name] ||= []
-                @references[table_name] << column_name
+              if column_name =~ /_id$/ and !@@indexes[table_name].include? column_name
+                add_error "always add db index (#{table_name} => #{column_name})"
               end
             end
           end
         end
       end
 
-      def remember_indexes(node)
-        add_index_nodes = node.grep_nodes({:node_type => :call, :message => :add_index})
-        add_index_nodes.each do |add_index_node|
-          table_name = add_index_node.arguments[1].to_ruby_string
-          column_name = add_index_node.arguments[2].to_ruby_string
-          @indexes[table_name] ||= []
-          @indexes[table_name] << column_name
+      # dynamically execute add_index because static parser can't handle
+      #
+      # [[:comments, :post_id], [:comments, :user_id]].each do |args|
+      #   add_index *args
+      # end
+      def remember_indexes(nodes)
+        nodes.each do |node|
+          begin
+            eval(node.to_ruby)
+          rescue
+          end
         end
       end
     end
   end
 end
+
+def add_index(*args)
+  table_name, column_names = *args
+  table_name = table_name.to_s
+  RailsBestPractices::Checks::AlwaysAddDbIndexCheck.indexes[table_name] ||= []
+  Array(column_names).each do |column_name|
+    RailsBestPractices::Checks::AlwaysAddDbIndexCheck.indexes[table_name] << column_name.to_s
+  end
+end

data/rails_best_practices.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rails_best_practices}
-  s.version = "0.3.3"
+  s.version = "0.3.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Huang"]
-  s.date = %q{2009-11-19}
+  s.date = %q{2009-11-22}
   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}
@@ -88,27 +88,27 @@ 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/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/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/many_to_many_collection_check_spec.rb",
-     "spec/rails_best_practices/checks/move_code_into_controller_check_spec.rb",
-     "spec/rails_best_practices/checks/move_code_into_helper_check_spec.rb",
-     "spec/rails_best_practices/checks/move_finder_to_named_scope_check_spec.rb",
+    "spec/rails_best_practices/checks/isolate_seed_data_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/move_code_into_helper_check_spec.rb",
+     "spec/rails_best_practices/checks/move_code_into_controller_check_spec.rb",
+     "spec/rails_best_practices/checks/use_observer_check_spec.rb",
      "spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb",
+     "spec/rails_best_practices/checks/nested_model_forms_check_spec.rb",
+     "spec/rails_best_practices/checks/always_add_db_index_check_spec.rb",
+     "spec/rails_best_practices/checks/many_to_many_collection_check_spec.rb",
+     "spec/rails_best_practices/checks/use_before_filter_check_spec.rb",
+     "spec/rails_best_practices/checks/law_of_demeter_check_spec.rb",
+     "spec/rails_best_practices/checks/use_scope_access_check_spec.rb",
      "spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb",
+     "spec/rails_best_practices/checks/not_use_default_route_check_spec.rb",
+     "spec/rails_best_practices/checks/move_finder_to_named_scope_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/replace_instance_variable_with_local_variable_check_spec.rb",
-     "spec/rails_best_practices/checks/use_before_filter_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/rails_best_practices/checks/needless_deep_nesting_check_spec.rb",
+     "spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/spec/rails_best_practices/checks/always_add_db_index_check_spec.rb

@@ -25,7 +25,8 @@ describe RailsBestPractices::Checks::AlwaysAddDbIndexCheck do
     @runner.check('db/migrate/20090918130258_create_comments.rb', content)
     errors = @runner.errors
     errors.should_not be_empty
-    errors[0].to_s.should == "db/migrate/20090918130258_create_comments.rb:2 - always add db index (comments => post_id, comments => user_id)"
+    errors[0].to_s.should == "db/migrate/20090918130258_create_comments.rb:2 - always add db index (comments => post_id)"
+    errors[1].to_s.should == "db/migrate/20090918130258_create_comments.rb:2 - always add db index (comments => user_id)"
   end
 
   it "should always add db index with column has no id" do
@@ -69,7 +70,8 @@ describe RailsBestPractices::Checks::AlwaysAddDbIndexCheck do
     @runner.check('db/migrate/20090918130258_create_comments.rb', content)
     errors = @runner.errors
     errors.should_not be_empty
-    errors[0].to_s.should == "db/migrate/20090918130258_create_comments.rb:2 - always add db index (comments => post_id, comments => user_id)"
+    errors[0].to_s.should == "db/migrate/20090918130258_create_comments.rb:2 - always add db index (comments => post_id)"
+    errors[1].to_s.should == "db/migrate/20090918130258_create_comments.rb:2 - always add db index (comments => user_id)"
   end
 
   it "should always add db index with column" do
@@ -92,7 +94,8 @@ describe RailsBestPractices::Checks::AlwaysAddDbIndexCheck do
     @runner.check('db/migrate/20090918130258_create_comments.rb', content)
     errors = @runner.errors
     errors.should_not be_empty
-    errors[0].to_s.should == "db/migrate/20090918130258_create_comments.rb:2 - always add db index (comments => post_id, comments => user_id)"
+    errors[0].to_s.should == "db/migrate/20090918130258_create_comments.rb:2 - always add db index (comments => post_id)"
+    errors[1].to_s.should == "db/migrate/20090918130258_create_comments.rb:2 - always add db index (comments => user_id)"
   end
 
   it "should not always add db index with add_index" do
@@ -145,9 +148,33 @@ describe RailsBestPractices::Checks::AlwaysAddDbIndexCheck do
     end
     EOF
     @runner.check('db/migrate/20090918130258_create_comments.rb', content)
-    @runner.check('db/migrate/20090919130258_add_indexes_to_comments.rb', content)
+    @runner.check('db/migrate/20090919130258_add_indexes_to_comments.rb', add_index_content)
     @runner.check('db/migrate/20090918130258_create_comments.rb', content)
-    @runner.check('db/migrate/20090919130258_add_indexes_to_comments.rb', content)
+    @runner.check('db/migrate/20090919130258_add_indexes_to_comments.rb', add_index_content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should always add db index without error" do
+    content = <<-EOF
+    class AddIndexes < ActiveRecord::Migration
+      def self.up
+        [[:site_wide_admins, :admin_id, { :unique => true }],
+         [:photos, [:target_id, :target_type, :type]],
+         [:photos, [:target_id, :target_type, :parent_id, :is_avatar]],
+         [:category_assignments, [:category_id, :sub_category_id, :target_id, :target_type]],
+         [:network_connections, :user_id]].each do |args|
+          add_index(*args) rescue say "Failed to add index"
+        end
+        # raise "abort migration"
+      end
+
+      def self.down
+      end
+    end
+    EOF
+    @runner.check('db/migrate/20091111113612_add_indexes.rb', content)
+    @runner.check('db/migrate/20091111113612_add_indexes.rb', content)
     errors = @runner.errors
   end
 end

data/spec/rails_best_practices/checks/use_before_filter_check_spec.rb

@@ -5,7 +5,7 @@ describe RailsBestPractices::Checks::UseBeforeFilterCheck do
     @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::UseBeforeFilterCheck.new)
   end
   
-  it "should use filter" do
+  it "should use before_filter" do
     content = <<-EOF
     class PostsController < ApplicationController
 
@@ -32,10 +32,10 @@ describe RailsBestPractices::Checks::UseBeforeFilterCheck do
     @runner.check('app/controllers/posts_controller.rb', content)
     errors = @runner.errors
     errors.should_not be_empty
-    errors[0].to_s.should == "app/controllers/posts_controller.rb:1 - use filter for @post = current_user.posts.find(params[:id]) in show,edit,update,destroy"
+    errors[0].to_s.should == "app/controllers/posts_controller.rb:1 - use before_filter for @post = current_user.posts.find(params[:id]) in show,edit,update,destroy"
   end
   
-  it "should not use filter" do
+  it "should not use before_filter" do
     content = <<-EOF
     class PostsController < ApplicationController
       before_filter :find_post, :only => [:show, :edit, :update, :destroy]
@@ -60,7 +60,7 @@ describe RailsBestPractices::Checks::UseBeforeFilterCheck do
     errors.should be_empty
   end
 
-  it "should not use filter by nil" do
+  it "should not use before_filter by nil" do
     content = <<-EOF
     class PostsController < ApplicationController
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rails_best_practices
 version: !ruby/object:Gem::Version 
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors: 
 - Richard Huang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-19 00:00:00 +08:00
+date: 2009-11-22 00:00:00 +08:00
 default_executable: rails_best_practices
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -133,25 +133,25 @@ signing_key:
 specification_version: 3
 summary: check rails files according to ihower's presentation 'rails best practices'
 test_files: 
-- 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/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/many_to_many_collection_check_spec.rb
-- spec/rails_best_practices/checks/move_code_into_controller_check_spec.rb
-- spec/rails_best_practices/checks/move_code_into_helper_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/move_code_into_helper_check_spec.rb
+- spec/rails_best_practices/checks/move_code_into_controller_check_spec.rb
+- spec/rails_best_practices/checks/use_observer_check_spec.rb
 - spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb
+- spec/rails_best_practices/checks/nested_model_forms_check_spec.rb
+- spec/rails_best_practices/checks/always_add_db_index_check_spec.rb
+- spec/rails_best_practices/checks/many_to_many_collection_check_spec.rb
+- spec/rails_best_practices/checks/use_before_filter_check_spec.rb
+- spec/rails_best_practices/checks/law_of_demeter_check_spec.rb
+- spec/rails_best_practices/checks/use_scope_access_check_spec.rb
 - spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb
+- spec/rails_best_practices/checks/not_use_default_route_check_spec.rb
+- spec/rails_best_practices/checks/move_finder_to_named_scope_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/replace_instance_variable_with_local_variable_check_spec.rb
-- spec/rails_best_practices/checks/use_before_filter_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/rails_best_practices/checks/needless_deep_nesting_check_spec.rb
+- spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb
 - spec/spec_helper.rb