rails_best_practices 0.2.0 → 0.3.0

data/README.textile

@@ -1,7 +1,14 @@
 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 static file parser tool based on ruby_parser.
+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.
+
+*************************************************
+
+h2. Resources
+
+"ihower's presentation":http://www.slideshare.net/ihower/rails-best-practices
+"Wiki":http://wiki.github.com/flyerhzm/rails_best_practices
 
 *************************************************
 
@@ -21,6 +28,8 @@ at the root directory of rails app
 rails_best_practices .
 </code></pre>
 
+notice the period at the end, it can be the relative or absolute path of your rails app.
+
 *************************************************
 
 h2. Customize Configuration
@@ -41,6 +50,15 @@ MoveModelLogicIntoModelCheck: { called_count: 4 }
 OveruseRouteCustomizationsCheck: { customize_count: 3 }
 NeedlessDeepNestingCheck: { nested_count: 2 }
 NotUseDefaultRouteCheck: {  }
+KeepFindersOnTheirOwnModelCheck: { }
+LawOfDemeterCheck: { }
+UseObserverCheck: { }
+IsolateSeedDataCheck: { }
+AlwaysAddDbIndexCheck: { }
+UseFilterCheck: { }
+MoveCodeIntoControllerCheck: { }
+MoveCodeIntoHelperCheck: { }
+ReplaceInstanceVariableWithLocalVariableCheck: { }
 </code></pre>
 
 *************************************************
@@ -65,29 +83,29 @@ h2. Progress
 ## [-Not use default route-]
 
 * Lesson 3. Model
-## Keep Finders on Their Own Model
-## Love named_scope
-## the Law of Demeter
+## [-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
+## [-Use Observer-]
 
 * Lesson 4. Migration
-## Isolating Seed Data
-## Always add DB index
+## [-Isolating Seed Data-]
+## [-Always add DB index-]
 
 * Lesson 5. Controller
-## Use before_filter
+## [-Use before_filter-]
 ## DRY Controller
 
 * Lesson 6. View
-## Move code into controller
+## [-Move code into controller-]
 ## Move code into model
-## Move code into helper
-## Replace instance variable with local variable
-## Use Form Builder
-## Organize Helper files
+## [-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
 
 *************************************************
 

data/Rakefile

@@ -27,7 +27,7 @@ Jeweler::Tasks.new do |gemspec|
   gemspec.email = "flyerhzm@gmail.com"
   gemspec.homepage = "http://github.com/flyerhzm/rails_best_practices"
   gemspec.authors = ["Richard Huang"]
-  gemspec.add_dependency 'ruby_parser'
-  gemspec.add_dependency 'ruby2ruby'
+  gemspec.add_dependency 'ruby_parser', '>= 2.0.4'
+  gemspec.add_dependency 'ruby2ruby', '>= 1.2.4'
 end
 Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/rails_best_practices/checks/add_model_virtual_attribute_check.rb

@@ -13,7 +13,7 @@ module RailsBestPractices
       end
       
       def interesting_files
-        /_controller.rb$/
+        CONTROLLER_FILES
       end
 
       def evaluate_start(node)
@@ -34,23 +34,28 @@ module RailsBestPractices
       
       def attribute_assignment(node)
         variable = node.subject
-        return if variable.nil?
+        arguments_node = nil
+        node.arguments.recursive_children do |child|
+          if :[] == child.message
+            arguments_node = child
+            break
+          end
+        end
+        return if variable.nil? or arguments_node.nil?
         @variables[variable] ||= []
-        @variables[variable] << {:message => node.message, :arguments => node.arguments}
+        @variables[variable] << {:message => node.message, :arguments => arguments_node}
       end
       
       def call_assignment(node)
         if node.message == :save
           variable = node.subject
-          add_error "add model virtual attribute (for #{node.subject.to_ruby})" if params_dup?(@variables[variable].collect {|h| h[:arguments] })
+          add_error "add model virtual attribute (for #{node.subject.to_ruby})" if params_dup?(@variables[variable].collect {|h| h[:arguments]})
         end
       end
       
       def params_dup?(nodes)
         return false if nodes.nil?
-        params_nodes = nodes.collect {|node| node.grep_nodes({:subject => s(:call, nil, :params, s(:arglist)), :message => :[]}).first}.compact
-        params_arguments = params_nodes.collect(&:arguments)
-        !params_arguments.dups.empty?
+        !nodes.dups.empty?
       end
     end
   end

data/lib/rails_best_practices/checks/always_add_db_index_check.rb

@@ -0,0 +1,90 @@
+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
+        [:defs]
+      end
+
+      def interesting_files
+        MIGRATION_FILES
+      end
+
+      def initialize
+        super
+        @files = []
+        @references = {}
+        @indexes = {}
+        @parse = false
+      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?
+          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
+          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
+        end
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/check.rb

@@ -3,7 +3,13 @@ require 'rails_best_practices/core/error'
 module RailsBestPractices
   module Checks
     class Check
-      NODE_TYPES = [:call, :defn, :if, :unless]
+      NODE_TYPES = [:call, :defn, :defs, :if, :unless, :class, :lasgn, :ivar]
+      
+      CONTROLLER_FILES = /_controller.rb$/
+      MIGRATION_FILES = /db\/migrate\/.*rb/
+      MODLE_FILES = /models\/.*rb/
+      VIEW_FILES = /views\/.*erb/
+      PARTIAL_VIEW_FILES = /views\/.*\/_.*erb/
 
       def initialize
         @errors = []
@@ -16,8 +22,8 @@ module RailsBestPractices
       NODE_TYPES.each do |node|
         start_node_method = "evaluate_start_#{node}"
         end_node_method = "evaluate_end_#{node}"
-        define_method(start_node_method) { } unless self.respond_to?(start_node_method)
-        define_method(end_node_method) { } unless self.respond_to?(end_node_method)
+        define_method(start_node_method) { |node| } unless self.respond_to?(start_node_method)
+        define_method(end_node_method) { |node| } unless self.respond_to?(end_node_method)
       end
 
       def position(offset = 0)

data/lib/rails_best_practices/checks/isolate_seed_data_check.rb

@@ -0,0 +1,59 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check a migration file to make sure not to insert data in migration, move them to seed file.
+    #
+    # Implementation: check if there are :create, :create!, and :new with :save or :save! exist, the migration file needs isolate seed data.
+    class IsolateSeedDataCheck < Check
+
+      def interesting_nodes
+        [:defs, :call, :lasgn]
+      end
+
+      def interesting_files
+        MIGRATION_FILES
+      end
+
+      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
+        end
+      end
+
+      private
+
+      def remember_new_variable(node)
+        unless node.grep_nodes({:node_type => :call, :message => :new}).empty?
+          @new_variables << node.subject.to_s
+        end
+      end
+
+      def new_record?(node)
+        @new_variables.include? node.subject.to_ruby
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/keep_finders_on_their_own_model_check.rb

@@ -0,0 +1,29 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check a model to make sure finders are on their own model.
+    #
+    # Implementation: check if :find is called by other model.
+    class KeepFindersOnTheirOwnModelCheck < Check
+      
+      def interesting_nodes
+        [:call]
+      end
+
+      def interesting_files
+        MODLE_FILES
+      end
+
+      def evaluate_start(node)
+        add_error "keep finders on their own model" if others_finder?(node)
+      end
+
+      private
+
+      def others_finder?(node)
+        node.message == :find and node.subject.node_type == :call
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/law_of_demeter_check.rb

@@ -0,0 +1,47 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # 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
+    class LawOfDemeterCheck < Check
+      
+      def interesting_nodes
+        [:call, :class]
+      end
+
+      def initialize
+        super
+        @associations = {}
+      end
+
+      def evaluate_start(node)
+        if node.node_type == :class
+          remember_belongs_to(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
+      end
+
+      private
+
+      def remember_belongs_to(node)
+        node.body.grep_nodes(:message => :belongs_to).collect do |body_node|
+          class_name = node.subject.to_s.underscore
+          @associations[class_name] ||= []
+          @associations[class_name] << body_node.arguments[1].to_ruby_string
+        end
+      end
+
+      def need_delegate?(node)
+        @associations.each do |class_name, associations|
+          return true if node.subject.to_ruby =~ /#{class_name}$/ and associations.include? node.message.to_s
+        end
+        false
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/move_code_into_controller_check.rb

@@ -0,0 +1,31 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check a view file to make sure there is no finder.
+    #
+    # Implementation: Check if view file contains finder, then the code should move to controller.
+    class MoveCodeIntoControllerCheck < Check
+      
+      FINDER = [:find, :all, :first, :last]
+      
+      def interesting_nodes
+        [:call]
+      end
+      
+      def interesting_files
+        VIEW_FILES
+      end
+      
+      def evaluate_start(node)
+        add_error "move code into controller" if finder?(node)
+      end
+      
+      private
+
+      def finder?(node)
+        node.subject.node_type == :const && FINDER.include?(node.message)
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/move_code_into_helper_check.rb

@@ -0,0 +1,29 @@
+require 'rails_best_practices/checks/check'
+
+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.
+    class MoveCodeIntoHelperCheck < Check
+    
+      def interesting_nodes
+        [:call]
+      end
+    
+      def interesting_files
+        VIEW_FILES
+      end
+
+      def evaluate_start(node)
+        add_error "move code into helper" 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
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/move_finder_to_named_scope_check.rb

@@ -16,7 +16,7 @@ module RailsBestPractices
       end
       
       def interesting_files
-        /_controller.rb$/
+        CONTROLLER_FILES
       end
 
       def evaluate_start(node)

data/lib/rails_best_practices/checks/move_model_logic_into_model_check.rb

@@ -13,7 +13,7 @@ module RailsBestPractices
       end
       
       def interesting_files
-        /_controller.rb$/
+        CONTROLLER_FILES
       end
 
       def initialize(options = {})

data/lib/rails_best_practices/checks/replace_complex_creation_with_factory_method_check.rb

@@ -13,7 +13,7 @@ module RailsBestPractices
       end
       
       def interesting_files
-        /_controller.rb$/
+        CONTROLLER_FILES
       end
       
       def initialize(options = {})

data/lib/rails_best_practices/checks/replace_instance_variable_with_local_variable_check.rb

@@ -0,0 +1,23 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check a partail view file to make sure there is no instance variable.
+    #
+    # Implementation: Check all instance variable, if exists, then it should be replaced with local variable
+    class ReplaceInstanceVariableWithLocalVariableCheck < Check
+      
+      def interesting_nodes
+        [:ivar]
+      end
+      
+      def interesting_files
+        PARTIAL_VIEW_FILES
+      end
+      
+      def evaluate_start(node)
+        add_error "replace instance variable with local variable"
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/use_filter_check.rb

@@ -0,0 +1,38 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check a controller file to make sure to use filter to remove duplicate call in different action.
+    #
+    # Implementation: Check all methods' first call, if they are duplicate, then should use filter.
+    class UseFilterCheck < Check
+
+      def interesting_nodes
+        [:class]
+      end
+
+      def interesting_files
+        CONTROLLER_FILES
+      end
+
+      def evaluate_start(node)
+        @methods = {}
+        node.grep_nodes({:node_type => :defn}).each { |method_node| remember_method(method_node) }
+        @methods.each do |first_call, method_names|
+          add_error "use filter for #{first_call.to_ruby} in #{method_names.join(',')}" if method_names.size > 1
+        end
+      end
+
+      private
+
+      def remember_method(method_node)
+        method_name = method_node.message_name
+        first_call = method_node.body[1]
+        unless first_call == s(:nil)
+          @methods[first_call] ||= []
+          @methods[first_call] << method_name
+        end
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/use_observer_check.rb

@@ -0,0 +1,49 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check a model file to make sure mail deliver method is in observer not callback.
+    #
+    # Implementation: 
+    # Record :after_create callback
+    # Check method define, if it is a callback and call deliver_xxx message in method body, then it should use observer.
+    class UseObserverCheck < Check
+
+      def interesting_nodes
+        [:defn, :call]
+      end
+
+      def interesting_files
+        MODLE_FILES
+      end
+
+      def initialize
+        super
+        @callbacks = []
+      end
+
+      def evaluate_start(node)
+        if :after_create == node.message
+          remember_callbacks(node)
+        elsif :defn == node.node_type and @callbacks.include?(node.message_name.to_s)
+          add_error "use observer" if use_observer?(node)
+        end
+      end
+
+      private
+
+      def remember_callbacks(node)
+        node.arguments[1..-1].each do |argument|
+          @callbacks << argument.to_ruby_string
+        end
+      end
+
+      def use_observer?(node)
+        node.recursive_children do |child|
+          return true if :call == child.node_type and :const == child.subject.node_type and child.message.to_s =~ /^deliver_/
+        end
+        false
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/use_scope_access_check.rb

@@ -12,7 +12,7 @@ module RailsBestPractices
       end
       
       def interesting_files
-        /_controller.rb$/
+        CONTROLLER_FILES
       end
       
       def evaluate_start(node)
@@ -26,7 +26,7 @@ module RailsBestPractices
         
         condition_node.message == :== and 
         (current_user?(condition_node.arguments.call) or current_user?(condition_node.subject)) and 
-        (node.false_node.method_body.any? {|n| n.message == :redirect_to} or node.true_node.method_body.any? {|n| n.message == :redirect_to})
+        (node.false_node.body.any? {|n| n.message == :redirect_to} or node.true_node.method_body.any? {|n| n.message == :redirect_to})
       end
       
       def current_user?(call_node)
@@ -35,4 +35,4 @@ module RailsBestPractices
       
     end
   end
-end
+end

data/lib/rails_best_practices/checks.rb

@@ -9,4 +9,13 @@ require 'rails_best_practices/checks/many_to_many_collection_check'
 require 'rails_best_practices/checks/nested_model_forms_check'
 require 'rails_best_practices/checks/overuse_route_customizations_check'
 require 'rails_best_practices/checks/needless_deep_nesting_check'
-require 'rails_best_practices/checks/not_use_default_route_check'
+require 'rails_best_practices/checks/not_use_default_route_check'
+require 'rails_best_practices/checks/keep_finders_on_their_own_model_check'
+require 'rails_best_practices/checks/law_of_demeter_check'
+require 'rails_best_practices/checks/use_observer_check'
+require 'rails_best_practices/checks/isolate_seed_data_check'
+require 'rails_best_practices/checks/always_add_db_index_check'
+require 'rails_best_practices/checks/use_filter_check'
+require 'rails_best_practices/checks/move_code_into_controller_check'
+require 'rails_best_practices/checks/move_code_into_helper_check'
+require 'rails_best_practices/checks/replace_instance_variable_with_local_variable_check'