rails_best_practices 0.3.0 → 0.4.0

data/README.textile

@@ -1,28 +1,27 @@
 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 from Kungfu RailsConf in Shanghai China.
-rails_best_practices is a code static parser tool.
+rails_best_practices is a code metric tool to check the quality of rails codes.
 
 *************************************************
 
 h2. Resources
 
-"ihower's presentation":http://www.slideshare.net/ihower/rails-best-practices
-"Wiki":http://wiki.github.com/flyerhzm/rails_best_practices
+Homepage: "http://rails-bestpractices.com":http://rails-bestpractices.com
+Wiki: "http://github.com/flyerhzm/rails_best_practices/wiki":http://github.com/flyerhzm/rails_best_practices/wiki
 
 *************************************************
 
 h2. Install
 
 <pre><code>
-sudo gem install rails_best_practices --source http://gemcutter.org
+sudo gem install rails_best_practices
 </code></pre>
 
 *************************************************
 
 h2. Usage
 
-at the root directory of rails app
+At the root directory of rails app
 
 <pre><code>
 rails_best_practices .
@@ -30,6 +29,31 @@ rails_best_practices .
 
 notice the period at the end, it can be the relative or absolute path of your rails app.
 
+And default rails_best_practices will do parse codes in vendor, spec, test and stories directories. If you need, see the command options:
+
+<pre><code>
+$ rails_best_practices -h
+Usage: rails_best_practices [options]
+    -d, --debug                      Debug mode
+        --vendor                     include vendor files
+        --spec                       include spec files
+        --test                       include test files
+        --stories                    include stories files
+    -h, --help                       Show this message
+</code></pre>
+
+*************************************************
+
+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
@@ -42,11 +66,8 @@ MoveFinderToNamedScopeCheck: { }
 UseModelAssociationCheck: { }
 UseScopeAccessCheck: { }
 AddModelVirtualAttributeCheck: { }
-# UseModelCallbackCheck: { }
 ReplaceComplexCreationWithFactoryMethodCheck: { attribute_assignment_count: 2 }
 MoveModelLogicIntoModelCheck: { called_count: 4 }
-# ManyToManyCollectionCheck: { }
-# NestedModelFormsCheck: { }
 OveruseRouteCustomizationsCheck: { customize_count: 3 }
 NeedlessDeepNestingCheck: { nested_count: 2 }
 NotUseDefaultRouteCheck: {  }
@@ -55,58 +76,55 @@ LawOfDemeterCheck: { }
 UseObserverCheck: { }
 IsolateSeedDataCheck: { }
 AlwaysAddDbIndexCheck: { }
-UseFilterCheck: { }
+UseBeforeFilterCheck: { }
 MoveCodeIntoControllerCheck: { }
-MoveCodeIntoHelperCheck: { }
+MoveCodeIntoModelCheck: { }
+MoveCodeIntoHelperCheck: { array_count: 3 }
 ReplaceInstanceVariableWithLocalVariableCheck: { }
 </code></pre>
 
 *************************************************
 
-h2. Progress
-
-* Lesson 1. Move code from Controller to Model
-## [-Move finder to named_scope-]
-## [-Use model association-]
-## [-Use scope access-]
-## [-Add model virtual attribute-]
-## Use model callback
-## [-Replace Complex Creation with Factory Method-]
-## [-Move Model Logic into the Model-]
-## model.collection_model_ids (many-to-many)
-## Nested Model Forms (one-to-one)
-## Nested Model Forms (one-to-many)
-
-* Lesson 2. RESTful Conventions
-## [-Overuse route customizations-]
-## [-Needless deep nesting-]
-## [-Not use default route-]
-
-* Lesson 3. Model
-## [-Keep Finders on Their Own Model-]
-## [-Love named_scope-] # same as Move finder to named_scope
-## [-the Law of Demeter-]
-## DRY: metaprogramming
-## Extract into Module
-## Extract to composed class
-## [-Use Observer-]
-
-* Lesson 4. Migration
-## [-Isolating Seed Data-]
-## [-Always add DB index-]
-
-* Lesson 5. Controller
-## [-Use before_filter-]
-## DRY Controller
-
-* Lesson 6. View
-## [-Move code into controller-]
+h2. Implementation
+
+* Move code from Controller to Model
+## Move finder to named_scope (rails2 only)
+## Use model association
+## Use scope access
+## Add model virtual attribute
+## Replace Complex Creation with Factory Method
+## Move Model Logic into the Model
+
+* RESTful Conventions
+## Overuse route customizations
+## Needless deep nesting
+## Not use default route
+
+* Model
+## Keep Finders on Their Own Model (rails2 only)
+## the Law of Demeter
+## Use Observer
+
+* Migration
+## Isolating Seed Data
+## Always add DB index
+
+* Controller
+## Use before_filter
+
+* View
+## Move code into controller
 ## Move code into model
-## [-Move code into helper-]
-## [-Replace instance variable with local variable-]
-## [-Use Form Builder-] # not implement, use http://github.com/justinfrench/formtastic
-## [-Organize Helper files-] # not implement, it's rails default behaviour
+## Move code into helper
+## Replace instance variable with local variable
+
+*************************************************
+
+h2. Links
+
+"http://railsenvy.com/2009/12/07/rails-envy-podcast-episode-102":http://railsenvy.com/2009/12/07/rails-envy-podcast-episode-102
+"http://ruby5.envylabs.com/episodes/29-episode-28-november-17-2009":http://ruby5.envylabs.com/episodes/29-episode-28-november-17-2009
 
 *************************************************
 
-Copyright © 2009 Richard Huang (flyerhzm@gmail.com), released under the MIT license
+Copyright © 2010 Richard Huang (flyerhzm@gmail.com), released under the MIT license

data/Rakefile

@@ -6,10 +6,10 @@ require 'jeweler'
 desc 'Default: run unit tests.'
 task :default => :spec
 
-desc 'Generate documentation for the sitemap plugin.'
+desc 'Generate documentation for the rails_best_practices plugin.'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Bullet'
+  rdoc.title    = 'rails_best_practices'
   rdoc.options << '--line-numbers' << '--inline-source'
   rdoc.rdoc_files.include('README')
   rdoc.rdoc_files.include('lib/**/*.rb')
@@ -22,10 +22,10 @@ end
 
 Jeweler::Tasks.new do |gemspec|
   gemspec.name = "rails_best_practices"
-  gemspec.summary = "check rails files according to ihower's presentation 'rails best practices'"
-  gemspec.description = "check rails files according to ihower's presentation 'rails best practices'"
+  gemspec.summary = "a code metric tool for rails codes."
+  gemspec.description = "a code metric tool for rails codes."
   gemspec.email = "flyerhzm@gmail.com"
-  gemspec.homepage = "http://github.com/flyerhzm/rails_best_practices"
+  gemspec.homepage = "http://rails-bestpractices.com"
   gemspec.authors = ["Richard Huang"]
   gemspec.add_dependency 'ruby_parser', '>= 2.0.4'
   gemspec.add_dependency 'ruby2ruby', '>= 1.2.4'

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/lib/rails_best_practices/checks/always_add_db_index_check.rb

@@ -2,89 +2,54 @@ require 'rails_best_practices/checks/check'
 
 module RailsBestPractices
   module Checks
-    # Check a migration file to make sure every reference key has a database index.
+    # Check db/schema.rb 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.
+    # 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.
     class AlwaysAddDbIndexCheck < Check
 
       def interesting_nodes
-        [:defs]
+        [:block, :call]
       end
 
       def interesting_files
-        MIGRATION_FILES
+        /db\/schema.rb/
       end
 
       def initialize
         super
-        @files = []
-        @references = {}
-        @indexes = {}
-        @parse = false
+        @index_columns = []
       end
 
       def evaluate_start(node)
-        if @files.include? node.file
-          @parse = true if :up == node.message
-        else
-          @files << node.file
-        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?
+        if :block == node.node_type
+          find_index_columns(node)
+        elsif :call == node.node_type
+          case node.message
+          when :create_table
+            @table_name = node.arguments[1].to_ruby_string
+          when :integer
+            column_name = node.arguments[1].to_ruby_string
+            if column_name =~ /_id$/ and !indexed?(@table_name, column_name)
+              add_error "always add db index (#@table_name => #{column_name})", node.file, node.line
+            end
           end
-        else
-          remember_references(node.body)
-          remember_indexes(node.body)
         end
       end
-
+      
       private
-
-      def remember_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
-            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
-          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
-              end
-            end
+        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_ruby_string
+            reference_column = eval(index_node.arguments[2].to_ruby)
+            @index_columns << [table_name, reference_column]
           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
+        
+        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)
+          end
         end
-      end
     end
   end
 end

data/lib/rails_best_practices/checks/check.rb

@@ -3,13 +3,15 @@ require 'rails_best_practices/core/error'
 module RailsBestPractices
   module Checks
     class Check
-      NODE_TYPES = [:call, :defn, :defs, :if, :unless, :class, :lasgn, :ivar]
+      NODE_TYPES = [:call, :defn, :defs, :if, :unless, :class, :lasgn, :ivar, :block, :iter]
       
-      CONTROLLER_FILES = /_controller.rb$/
-      MIGRATION_FILES = /db\/migrate\/.*rb/
-      MODLE_FILES = /models\/.*rb/
-      VIEW_FILES = /views\/.*erb/
-      PARTIAL_VIEW_FILES = /views\/.*\/_.*erb/
+      CONTROLLER_FILES = /_controller\.rb$/
+      MIGRATION_FILES = /db\/migrate\/.*\.rb/
+      MODLE_FILES = /models\/.*\.rb/
+      VIEW_FILES = /views\/.*\.(erb|haml)/
+      PARTIAL_VIEW_FILES = /views\/.*\/_.*\.(erb|haml)/
+
+      attr_reader :errors
 
       def initialize
         @errors = []
@@ -52,13 +54,10 @@ module RailsBestPractices
         evaluate_end(node)
       end
       
-      def add_error(error, line = nil)
-        line = @node.line if line.nil?
-        @errors << RailsBestPractices::Core::Error.new("#{@node.file}", "#{line}", error)
-      end
-  
-      def errors
-        @errors
+      def add_error(error, file = nil, line = nil)
+        file ||= @node.file
+        line ||= @node.line
+        @errors << RailsBestPractices::Core::Error.new("#{file}", "#{line}", error)
       end
     end
   end

data/lib/rails_best_practices/checks/isolate_seed_data_check.rb

@@ -8,7 +8,7 @@ module RailsBestPractices
     class IsolateSeedDataCheck < Check
 
       def interesting_nodes
-        [:defs, :call, :lasgn]
+        [:call, :lasgn]
       end
 
       def interesting_files
@@ -18,28 +18,15 @@ module RailsBestPractices
       def initialize
         super
         @new_variables = []
-        @files = []
-        @parse = false
       end
 
       def evaluate_start(node)
-        # check duplicate migration because of always_add_db_index_check.
-        if :defs == node.node_type
-          if @files.include? node.file
-            @parse = true if :up == node.message
-          else
-            @files << node.file
-          end
-        end
-        
-        if @parse
-          if [:create, :create!].include? node.message
-            add_error("isolate seed data")
-          elsif :lasgn == node.node_type
-            remember_new_variable(node)
-          elsif [:save, :save!].include? node.message
-            add_error("isolate seed data") if new_record?(node)
-          end
+        if [:create, :create!].include? node.message
+          add_error("isolate seed data")
+        elsif :lasgn == node.node_type
+          remember_new_variable(node)
+        elsif [:save, :save!].include? node.message
+          add_error("isolate seed data") if new_record?(node)
         end
       end
 

data/lib/rails_best_practices/checks/keep_finders_on_their_own_model_check.rb

@@ -22,7 +22,7 @@ module RailsBestPractices
       private
 
       def others_finder?(node)
-        node.message == :find and node.subject.node_type == :call
+        [:find, :all, :first, :last].include? node.message and node.subject.node_type == :call and node.arguments.size > 1
       end
     end
   end

data/lib/rails_best_practices/checks/law_of_demeter_check.rb

@@ -5,8 +5,8 @@ module RailsBestPractices
     # Check to make sure not avoid the law of demeter.
     # 
     # Implementation: 
-    # 1. check all models to record belongs_to associations
-    # 2. check if calling belongs_to association's method or attribute
+    # 1. check all models to record belongs_to and has_one associations
+    # 2. check if calling belongs_to and has_one association's method or attribute
     class LawOfDemeterCheck < Check
       
       def interesting_nodes
@@ -20,7 +20,7 @@ module RailsBestPractices
 
       def evaluate_start(node)
         if node.node_type == :class
-          remember_belongs_to(node)
+          remember_association(node)
         elsif [:lvar, :ivar].include?(node.subject.node_type) and node.subject != s(:lvar, :_erbout)
           add_error "law of demeter" if need_delegate?(node)
         end
@@ -28,8 +28,9 @@ module RailsBestPractices
 
       private
 
-      def remember_belongs_to(node)
-        node.body.grep_nodes(:message => :belongs_to).collect do |body_node|
+      # remember belongs_to or has_one node
+      def remember_association(node)
+        (node.body.grep_nodes(:message => :belongs_to) + node.body.grep_nodes(:message => :has_one)).collect do |body_node|
           class_name = node.subject.to_s.underscore
           @associations[class_name] ||= []
           @associations[class_name] << body_node.arguments[1].to_ruby_string

data/lib/rails_best_practices/checks/move_code_into_helper_check.rb

@@ -4,7 +4,7 @@ module RailsBestPractices
   module Checks
     # Check a view file to make sure there is no complex options_for_select message call.
     #
-    # Implementation: Check if arguments of options_for_select message call contain more than 2 method call, then move it into helper.
+    # Implementation: Check if first argument of options_for_select is an array and contains more than two nodes, then it should be moved into helper.
     class MoveCodeIntoHelperCheck < Check
     
       def interesting_nodes
@@ -15,14 +15,19 @@ module RailsBestPractices
         VIEW_FILES
       end
 
+      def initialize(options = {})
+        super()
+        @array_count = options['array_count'] || 3
+      end
+
       def evaluate_start(node)
-        add_error "move code into helper" if complex_select_options?(node)
+        add_error "move code into helper (array_count >= #{@array_count})" if complex_select_options?(node)
       end
       
       private
       
       def complex_select_options?(node)
-        :options_for_select == node.message and node.arguments.grep_nodes(:node_type => :call).size > 2
+        :options_for_select == node.message and :array == node.arguments[1].node_type and node.arguments[1].size > @array_count
       end
     end
   end

data/lib/rails_best_practices/checks/move_code_into_model_check.rb

@@ -0,0 +1,53 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check a view file to make sure there is no complex logic call for model.
+    #
+    # Implementation: Check if a local variable or instance variable called greater than 2 times in if or unless conditional statement, then it should more code into model.
+    class MoveCodeIntoModelCheck < Check
+
+      def interesting_nodes
+        [:if, :unless]
+      end
+
+      def interesting_files
+        VIEW_FILES
+      end
+
+      def evaluate_start(node)
+        @variables = {}
+        node.conditional_statement.grep_nodes(:node_type => :call).each { |call_node| remember_call(call_node) }
+        check_errors
+      end
+
+      private
+
+      def check_errors
+        @variables.each do |node, count|
+          add_error "move code into model (#{node.to_ruby})" if count > 2
+        end
+      end
+
+      def remember_call(call_node)
+        variable_node = variable(call_node)
+        if variable_node
+          @variables[variable_node] ||= 0
+          @variables[variable_node] += 1
+        end
+      end
+
+      def variable(call_node)
+        while call_node.subject.node_type == :call
+          call_node = call_node.subject
+        end
+        subject_node = call_node.subject
+        if [:ivar, :lvar].include?(subject_node.node_type) and subject_node[1] != :_erbout
+          subject_node
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/needless_deep_nesting_check.rb

@@ -8,7 +8,7 @@ module RailsBestPractices
     class NeedlessDeepNestingCheck < Check
       
       def interesting_nodes
-        [:call]
+        [:call, :iter]
       end
 
       def interesting_files
@@ -17,11 +17,28 @@ module RailsBestPractices
 
       def initialize(options = {})
         super()
+        @counter = 0
         @nested_count = options['nested_count'] || 2
       end
       
       def evaluate_start(node)
-        if node.message == :resources
+        check_nested_count(node)
+      end
+
+      private
+        def check_nested_count(node)
+          if :iter == node.node_type
+            check_for_rails3(node)
+          elsif :resources == node.message and node.subject
+            check_for_rails2(node)
+          end
+        end
+
+        def check_for_rails3(node)
+          nested_count_for_rails3(node)
+        end
+
+        def check_for_rails2(node)
           if node.subject == s(:call, nil, :map, s(:arglist))
             @counter = 0
           else
@@ -29,7 +46,22 @@ module RailsBestPractices
             add_error "needless deep nesting (nested_count > #{@nested_count})" if @counter >= @nested_count
           end
         end
-      end
+
+        def nested_count_for_rails3(node)
+          if :iter == node.node_type and :resources == node.subject.message and !node.message
+            @counter += 1
+            nested_count_for_rails3(node[3])
+            @counter -= 1
+          elsif :block == node.node_type
+            node.children.each do |child_node|
+              if :resources == child_node.message and nil == child_node.subject and @counter + 1 > @nested_count
+                add_error "needless deep nesting (nested_count > #{@nested_count})", child_node.file, child_node.line
+              end
+            end
+          elsif :call == node.node_type and :resources == node.message
+            add_error "needless deep nesting (nested_count > #{@nested_count})", node.file, node.line if @counter + 1 > @nested_count
+          end
+        end
     end
   end
-end
+end

data/lib/rails_best_practices/checks/not_use_default_route_check.rb

@@ -17,10 +17,11 @@ module RailsBestPractices
       
       def evaluate_start(node)
         if node == s(:call, s(:lvar, :map), :connect, s(:arglist, s(:str, ":controller/:action/:id"))) or
-           node == s(:call, s(:lvar, :map), :connect, s(:arglist, s(:str, ":controller/:action/:id.:format")))
+           node == s(:call, s(:lvar, :map), :connect, s(:arglist, s(:str, ":controller/:action/:id.:format"))) or
+           node == s(:call, nil, :match, s(:arglist, s(:str, ":controller(/:action(/:id(.:format)))")))
           add_error "not use default route"
         end
       end
     end
   end
-end
+end