rails_best_practices 0.5.0 → 0.5.1

data/lib/rails_best_practices/checks/always_add_db_index_check.rb

@@ -5,11 +5,11 @@ module RailsBestPractices
   module Checks
     # Check db/schema.rb file to make sure every reference key has a database index.
     #
-    # Implementation: read all add_index method calls to get the indexed columns in table, then read integer method call in create_table block to get the reference columns in tables, compare with indexed columns, if not in the indexed columns, then it violates always_add_db_index_check.
+    # Implementation: read all add_index method calls to get the indexed columns in table, then read integer method call in create_table block to get the reference columns in tables (or polymorphic index like [commentable_id, commentable_type]), compare with indexed columns, if not in the indexed columns, then it violates always_add_db_index_check.
     class AlwaysAddDbIndexCheck < Check
 
       def interesting_nodes
-        [:block, :call]
+        [:block, :call, :iter]
       end
 
       def interesting_files
@@ -18,7 +18,9 @@ module RailsBestPractices
 
       def initialize
         super
-        @index_columns = []
+        @index_columns = {}
+        @foreign_keys = {}
+        @table_nodes = {}
       end
 
       def evaluate_start(node)
@@ -28,27 +30,48 @@ module RailsBestPractices
           case node.message
           when :create_table
             @table_name = node.arguments[1].to_s
-          when :integer
+            @table_nodes[@table_name] = node
+          when :integer, :string
             column_name = node.arguments[1].to_s
-            if column_name =~ /_id$/ and !indexed?(@table_name, column_name)
-              add_error "always add db index (#@table_name => #{column_name})", node.file, node.line
+            add_foreign_key_column(@table_name, column_name)
+          end
+        end
+      end
+
+      def evaluate_end(node)
+        if :iter == node.node_type && :call == node.subject.node_type && s(:colon2, s(:const, :ActiveRecord), :Schema) == node.subject.subject
+          @foreign_keys.each do |table, foreign_key|
+            table_node = @table_nodes[table]
+            foreign_key.each do |column|
+              unless @index_columns[table] && @index_columns[table].include?(column)
+                add_error "always add db index (#{table} => [#{Array(column).join(', ')}])", table_node.file, table_node.line
+              end
             end
           end
         end
       end
-      
+
       private
         def find_index_columns(node)
           node.grep_nodes({:node_type => :call, :message => :add_index}).each do |index_node|
             table_name = index_node.arguments[1].to_s
-            reference_column = eval(index_node.arguments[2].to_s)
-            @index_columns << [table_name, reference_column]
+            index_column = eval(index_node.arguments[2].to_s)
+            add_index_column(table_name, index_column)
           end
         end
-        
-        def indexed?(table_name, column_name)
-          !!@index_columns.find do |reference|
-            reference[0] == table_name and reference[1].class == String ? reference[1] == column_name : reference[1].include?(column_name)
+
+        def add_index_column(table_name, index_column)
+          @index_columns[table_name] ||= []
+          @index_columns[table_name] << (index_column.size == 1 ? index_column[0] : index_column)
+        end
+
+        def add_foreign_key_column(table_name, foreign_key_column)
+          if foreign_key_column =~ /_id$/
+            @foreign_keys[table_name] ||= []
+            @foreign_keys[table_name] << foreign_key_column
+          elsif foreign_key_column =~ /(.*?)_type$/
+            @foreign_keys[table_name].delete("#{$1}_id")
+            @foreign_keys[table_name] << ["#{$1}_id", foreign_key_column]
           end
         end
     end

data/lib/rails_best_practices/command.rb

@@ -6,7 +6,7 @@ require 'colored'
 options = {}
 OptionParser.new do |opts|
   opts.banner = "Usage: rails_best_practices [options]"
-  
+
   opts.on("-d", "--debug", "Debug mode") do
     options['debug'] = true
   end
@@ -16,7 +16,7 @@ OptionParser.new do |opts|
       options[pattern] = true
     end
   end
-  
+
   opts.on_tail('-v', '--version', 'Show this version') do
     require 'rails_best_practices/version'
     puts RailsBestPractices::VERSION
@@ -27,7 +27,7 @@ OptionParser.new do |opts|
     puts opts
     exit
   end
-  
+
   opts.on("-x", "--exclude PATTERNS", "Don't analyze files matching a pattern", "(comma-separated regexp list)") do |list|
     begin
       options[:exclude] = list.split(/,/).map{|x| Regexp.new x}
@@ -43,6 +43,12 @@ runner = RailsBestPractices::Core::Runner.new
 runner.set_debug if options['debug']
 
 files = RailsBestPractices::analyze_files(ARGV, options)
+
+if runner.checks.find { |check| check.is_a? RailsBestPractices::Checks::AlwaysAddDbIndexCheck } &&
+   !files.find { |file| file.index "db\/schema.rb" }
+  puts "AlwaysAddDbIndexCheck is disabled as there is no db/schema.rb file in your rails project.".blue
+end
+
 bar = ProgressBar.new('Analyzing', files.size)
 files.each do |file|
   runner.check_file(file)
@@ -50,9 +56,11 @@ files.each do |file|
 end
 bar.finish
 
-runner.errors.each {|error| puts error.to_s.red}
+runner.errors.each { |error| puts error.to_s.red }
 puts "\nPlease go to http://rails-bestpractices.com to see more useful Rails Best Practices.".green
-if runner.errors.size > 0
+if runner.errors.empty?
+  puts "\nNo error found. Cool!".green
+else
   puts "\nFound #{runner.errors.size} errors.".red
 end
 

data/lib/rails_best_practices/core/runner.rb

@@ -8,9 +8,11 @@ require 'active_support/inflector'
 module RailsBestPractices
   module Core
     class Runner
+      attr_reader :checks
+
       DEFAULT_CONFIG = File.join(File.dirname(__FILE__), "..", "..", "..", "rails_best_practices.yml")
       CUSTOM_CONFIG = File.join('config', 'rails_best_practices.yml')
-      
+
       def initialize(*checks)
         @config = File.exists?(CUSTOM_CONFIG) ? CUSTOM_CONFIG : DEFAULT_CONFIG
         @checks = checks unless checks.empty?
@@ -18,7 +20,7 @@ module RailsBestPractices
         @checker ||= CheckingVisitor.new(@checks)
         @debug = false
       end
-      
+
       def set_debug
         @debug = true
       end
@@ -67,11 +69,11 @@ module RailsBestPractices
           nil
         end
       end
-      
+
       def load_checks
         check_objects = []
         checks = YAML.load_file @config
-        checks.each do |check| 
+        checks.each do |check|
           klass = eval("RailsBestPractices::Checks::#{check[0]}")
           check_objects << (check[1].empty? ? klass.new : klass.new(check[1]))
         end

data/lib/rails_best_practices/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 module RailsBestPractices
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rails_best_practices
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: false
   segments: 
   - 0
   - 5
-  - 0
-  version: 0.5.0
+  - 1
+  version: 0.5.1
 platform: ruby
 authors: 
 - Richard Huang
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-06 00:00:00 +08:00
+date: 2010-12-01 00:00:00 +08:00
 default_executable: rails_best_practices
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -75,12 +75,26 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: activesupport
+  name: i18n
   prerelease: false
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: activesupport
+  prerelease: false
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -94,9 +108,9 @@ dependencies:
   name: rspec
   prerelease: false
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -110,9 +124,9 @@ dependencies:
   name: haml
   prerelease: false
   type: :development
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -125,7 +139,7 @@ dependencies:
   name: watchr
   prerelease: false
   type: :development
-  version_requirements: *id007
+  version_requirements: *id008
 description: a code metric tool for rails codes, written in Ruby.
 email: 
 - flyerhzm@gmail.com
@@ -137,39 +151,39 @@ extra_rdoc_files:
 - MIT_LICENSE
 - README.textile
 files: 
-- lib/rails_best_practices.rb
-- lib/rails_best_practices/version.rb
-- lib/rails_best_practices/checks/move_finder_to_named_scope_check.rb
-- lib/rails_best_practices/checks/use_model_association_check.rb
-- lib/rails_best_practices/checks/keep_finders_on_their_own_model_check.rb
 - lib/rails_best_practices/checks/add_model_virtual_attribute_check.rb
-- lib/rails_best_practices/checks/use_say_with_time_in_migrations_check.rb
+- lib/rails_best_practices/checks/always_add_db_index_check.rb
+- lib/rails_best_practices/checks/check.rb
+- lib/rails_best_practices/checks/dry_bundler_in_capistrano_check.rb
+- lib/rails_best_practices/checks/isolate_seed_data_check.rb
+- lib/rails_best_practices/checks/keep_finders_on_their_own_model_check.rb
 - lib/rails_best_practices/checks/law_of_demeter_check.rb
-- lib/rails_best_practices/checks/use_scope_access_check.rb
 - lib/rails_best_practices/checks/move_code_into_controller_check.rb
+- lib/rails_best_practices/checks/move_code_into_helper_check.rb
+- lib/rails_best_practices/checks/move_code_into_model_check.rb
+- lib/rails_best_practices/checks/move_finder_to_named_scope_check.rb
 - lib/rails_best_practices/checks/move_model_logic_into_model_check.rb
+- lib/rails_best_practices/checks/needless_deep_nesting_check.rb
 - lib/rails_best_practices/checks/not_use_default_route_check.rb
+- lib/rails_best_practices/checks/overuse_route_customizations_check.rb
 - lib/rails_best_practices/checks/replace_complex_creation_with_factory_method_check.rb
-- lib/rails_best_practices/checks/dry_bundler_in_capistrano_check.rb
-- lib/rails_best_practices/checks/isolate_seed_data_check.rb
-- lib/rails_best_practices/checks/always_add_db_index_check.rb
 - lib/rails_best_practices/checks/replace_instance_variable_with_local_variable_check.rb
-- lib/rails_best_practices/checks/needless_deep_nesting_check.rb
-- lib/rails_best_practices/checks/move_code_into_helper_check.rb
+- lib/rails_best_practices/checks/use_before_filter_check.rb
+- lib/rails_best_practices/checks/use_model_association_check.rb
 - lib/rails_best_practices/checks/use_observer_check.rb
-- lib/rails_best_practices/checks/check.rb
-- lib/rails_best_practices/checks/overuse_route_customizations_check.rb
 - lib/rails_best_practices/checks/use_query_attribute_check.rb
-- lib/rails_best_practices/checks/use_before_filter_check.rb
-- lib/rails_best_practices/checks/move_code_into_model_check.rb
-- lib/rails_best_practices/core.rb
+- lib/rails_best_practices/checks/use_say_with_time_in_migrations_check.rb
+- lib/rails_best_practices/checks/use_scope_access_check.rb
 - lib/rails_best_practices/checks.rb
+- lib/rails_best_practices/command.rb
 - lib/rails_best_practices/core/checking_visitor.rb
 - lib/rails_best_practices/core/core_ext.rb
 - lib/rails_best_practices/core/error.rb
-- lib/rails_best_practices/core/visitable_sexp.rb
 - lib/rails_best_practices/core/runner.rb
-- lib/rails_best_practices/command.rb
+- lib/rails_best_practices/core/visitable_sexp.rb
+- lib/rails_best_practices/core.rb
+- lib/rails_best_practices/version.rb
+- lib/rails_best_practices.rb
 - rails_best_practices.yml
 - MIT_LICENSE
 - README.textile