rails_best_practices 0.6.6 → 0.6.7

data/lib/rails_best_practices/{checks/move_code_into_model_check.rb → reviews/move_code_into_model_review.rb}

@@ -1,31 +1,28 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
-    # Check a view file to make sure there is no complex logic call for model.
+  module Reviews
+    # Review a view file to make sure there is no complex logic call for model.
     #
     # See the best practice details here http://rails-bestpractices.com/posts/25-move-code-into-model.
     #
     # Implementation:
     #
-    # Prepare process:
-    #   none
-    #
     # Review process:
     #   check if there are multiple method calls or attribute assignments apply to one subject,
     #   and the subject is a local variable or instance variable,
     #   then they should be moved into model.
-    class MoveCodeIntoModelCheck < Check
+    class MoveCodeIntoModelReview < Review
       def url
         "http://rails-bestpractices.com/posts/25-move-code-into-model"
       end
 
-      def interesting_review_nodes
+      def interesting_nodes
         [:if]
       end
 
-      def interesting_review_files
+      def interesting_files
         VIEW_FILES
       end
 
@@ -41,7 +38,7 @@ module RailsBestPractices
       # if there are multiple call and attrasgn nodes who have the same subject,
       # and the subject is a local variable or an instance variable,
       # then the conditional statement nodes should be moved into model.
-      def review_start_if(node)
+      def start_if(node)
         node.conditional_statement.grep_nodes(:node_type => [:call, :attrasgn]) { |child_node| remember_variable_use_count(child_node) }
 
         variable_use_count.each do |variable_node, count|

data/lib/rails_best_practices/{checks/move_finder_to_named_scope_check.rb → reviews/move_finder_to_named_scope_review.rb}

@@ -1,23 +1,20 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
-    # Check a controller file to make sure there are no complex finder.
+  module Reviews
+    # Review a controller file to make sure there are no complex finder.
     #
     # See the best practice details here http://rails-bestpractices.com/posts/1-move-finder-to-named_scope.
     #
     # Implementation:
     #
-    # Prepare process:
-    #   none
-    #
     # Review process:
     #   check all method calls in controller files.
     #   if there is any call node with message find, all, first or last,
     #   and it has a hash argument,
     #   then it is a complex finder, and should be moved to model's named scope.
-    class MoveFinderToNamedScopeCheck < Check
+    class MoveFinderToNamedScopeReview < Review
 
       FINDER = [:find, :all, :first, :last]
 
@@ -25,18 +22,18 @@ module RailsBestPractices
         "http://rails-bestpractices.com/posts/1-move-finder-to-named_scope"
       end
 
-      def interesting_review_nodes
+      def interesting_nodes
         [:call]
       end
 
-      def interesting_review_files
+      def interesting_files
         CONTROLLER_FILES
       end
 
       # check call node if its message is one of :find, :all, :first or :last,
       # and it has a hash argument,
       # then the call node is the finder that should be moved to model's named_scope.
-      def review_start_call(node)
+      def start_call(node)
         add_error "move finder to named_scope" if finder?(node)
       end
 

data/lib/rails_best_practices/{checks/move_model_logic_into_model_check.rb → reviews/move_model_logic_into_model_review.rb}

@@ -1,32 +1,29 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
-    # Check a controller file to make sure that complex model logic should not exist in controller, should be moved into a model.
+  module Reviews
+    # Review a controller file to make sure that complex model logic should not exist in controller, should be moved into a model.
     #
     # See the best practice details here http://rails-bestpractices.com/posts/7-move-model-logic-into-the-model.
     #
     # Implementation:
     #
-    # Prepare process:
-    #   none
-    #
     # Review process:
     #   check all method defines in the controller files,
     #   if there are multiple method calls or attribute assignments apply to one subject,
     #   and the subject is a local variable or an instance variable,
     #   then they are complex model logic, and they should be moved into model.
-    class MoveModelLogicIntoModelCheck < Check
+    class MoveModelLogicIntoModelReview < Review
       def url
         "http://rails-bestpractices.com/posts/7-move-model-logic-into-the-model"
       end
 
-      def interesting_review_nodes
+      def interesting_nodes
         [:defn]
       end
 
-      def interesting_review_files
+      def interesting_files
         CONTROLLER_FILES
       end
 
@@ -35,13 +32,13 @@ module RailsBestPractices
         @use_count = options['use_count'] || 4
       end
 
-      # check method define node to see if there are multiple method calls and attribute assignments (more than @use_count defined) on one local variable or instance varialbe in review process.
+      # check method define node to see if there are multiple method calls and attribute assignments (more than @use_count defined) on one local variable or instance varialbe.
       #
       # it will check every call and attrasgn nodes,
       # if there are multiple call and attrasgn nodes who have the same subject,
       # and the subject is a local variable or an instance variable,
       # then these method calls and attribute assignments should be moved into model.
-      def review_start_defn(node)
+      def start_defn(node)
         node.grep_nodes(:node_type => [:call, :attrasgn]) do |child_node|
           remember_variable_use_count(child_node)
         end

data/lib/rails_best_practices/{checks/needless_deep_nesting_check.rb → reviews/needless_deep_nesting_review.rb}

@@ -1,17 +1,14 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
-    # Check config/routes.rb file to make sure not to use too deep nesting routes.
+  module Reviews
+    # Review config/routes.rb file to make sure not to use too deep nesting routes.
     #
     # See the best practice details here http://rails-bestpractices.com/posts/11-needless-deep-nesting.
     #
     # Implementation:
     #
-    # Prepare process:
-    #   none
-    #
     # Review process:
     #   chech all iter nodes in route file.
     #
@@ -29,16 +26,16 @@ module RailsBestPractices
     #   and the message of the node is :resources or :resource,
     #   and the @counter is greater than @nested_count defined,
     #   then it is a needless deep nesting.
-    class NeedlessDeepNestingCheck < Check
+    class NeedlessDeepNestingReview < Review
       def url
         "http://rails-bestpractices.com/posts/11-needless-deep-nesting"
       end
 
-      def interesting_review_nodes
+      def interesting_nodes
         [:call, :iter]
       end
 
-      def interesting_review_files
+      def interesting_files
         ROUTE_FILE
       end
 
@@ -48,7 +45,7 @@ module RailsBestPractices
         @nested_count = options['nested_count'] || 2
       end
 
-      # check all iter node in review process.
+      # check all iter node.
       #
       # It is a recursively check,
       #
@@ -76,7 +73,7 @@ module RailsBestPractices
       #
       # test if the @counter is greater than or equal to @nested_count,
       # if so, it is a needless deep nesting.
-      def review_start_iter(node)
+      def start_iter(node)
         recursively_check(node)
       end
 

data/lib/rails_best_practices/{checks/not_use_default_route_check.rb → reviews/not_use_default_route_review.rb}

@@ -1,17 +1,14 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
-    # Check config/routes file to make sure not use default route that rails generated.
+  module Reviews
+    # Review config/routes file to make sure not use default route that rails generated.
     #
     # See the best practice details here http://rails-bestpractices.com/posts/12-not-use-default-route-if-you-use-restful-design
     #
     # Implementation:
     #
-    # Prepare process:
-    #   none
-    #
     # Review process:
     #   check all method call to see if any method call is the same as rails default route.
     #
@@ -21,16 +18,16 @@ module RailsBestPractices
     #   or
     #
     #     match ':controller(/:action(/:id(.:format)))'
-    class NotUseDefaultRouteCheck < Check
+    class NotUseDefaultRouteReview < Review
       def url
         "http://rails-bestpractices.com/posts/12-not-use-default-route-if-you-use-restful-design"
       end
 
-      def interesting_review_nodes
+      def interesting_nodes
         [:call]
       end
 
-      def interesting_review_files
+      def interesting_files
         ROUTE_FILE
       end
 
@@ -50,7 +47,7 @@ module RailsBestPractices
       #     s(:call, nil, :match,
       #       s(:arglist, s(:str, ":controller(/:action(/:id(.:format)))"))
       #     )
-      def review_start_call(node)
+      def start_call(node)
         if s(:call, s(:lvar, :map), :connect, s(:arglist, s(:str, ":controller/:action/:id"))) == node ||
            s(:call, s(:lvar, :map), :connect, s(:arglist, s(:str, ":controller/:action/:id.:format"))) == node ||
            s(:call, nil, :match, s(:arglist, s(:str, ":controller(/:action(/:id(.:format)))"))) == node

data/lib/rails_best_practices/{checks/overuse_route_customizations_check.rb → reviews/overuse_route_customizations_review.rb}

@@ -1,17 +1,14 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
-    # Check config/routes.rb file to make sure there are no overuse route customizations.
+  module Reviews
+    # Review config/routes.rb file to make sure there are no overuse route customizations.
     #
     # See the best practice details here http://rails-bestpractices.com/posts/10-overuse-route-customizations.
     #
     # Implementation:
     #
-    # Prepare process:
-    #   none
-    #
     # Review process:
     #   the check methods are different for rails2 and rails3 syntax.
     #
@@ -30,7 +27,7 @@ module RailsBestPractices
     #   and in the block body of iter node, there are more than @customize_count call nodes,
     #   whose message is :get, :post, :update or :delete,
     #   then these custom routes are overuse.
-    class OveruseRouteCustomizationsCheck < Check
+    class OveruseRouteCustomizationsReview < Review
 
       VERBS = [:get, :post, :update, :delete]
 
@@ -38,11 +35,11 @@ module RailsBestPractices
         "http://rails-bestpractices.com/posts/10-overuse-route-customizations"
       end
 
-      def interesting_review_nodes
+      def interesting_nodes
         [:call, :iter]
       end
 
-      def interesting_review_files
+      def interesting_files
         ROUTE_FILE
       end
 
@@ -51,7 +48,7 @@ module RailsBestPractices
         @customize_count = options['customize_count'] || 3
       end
 
-      # check call node to see if the count of member and collection custom routes is more than @customize_count defined in review process.
+      # check call node to see if the count of member and collection custom routes is more than @customize_count defined.
       # this is for rails2 syntax.
       #
       # if the message of call node is :resources,
@@ -64,13 +61,13 @@ module RailsBestPractices
       #                           :collection => { :comments => :get }
       #
       # then they are overuse route customizations.
-      def review_start_call(node)
+      def start_call(node)
         if member_and_collection_count_for_rails2(node) > @customize_count
           add_error "overuse route customizations (customize_count > #{@customize_count})", node.file, node.subject.line
         end
       end
 
-      # check iter node to see if the count of member and collection custom routes is more than @customize_count defined in review process.
+      # check iter node to see if the count of member and collection custom routes is more than @customize_count defined.
       # this is for rails3 syntax.
       #
       # if the subject of iter node is with message :resources,
@@ -90,7 +87,7 @@ module RailsBestPractices
       #     end
       #
       # then they are overuse route customizations.
-      def review_start_iter(node)
+      def start_iter(node)
         if member_and_collection_count_for_rails3(node) > @customize_count
           add_error "overuse route customizations (customize_count > #{@customize_count})", node.file, node.subject.line
         end

data/lib/rails_best_practices/{checks/replace_complex_creation_with_factory_method_check.rb → reviews/replace_complex_creation_with_factory_method_review.rb}

@@ -1,33 +1,30 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
-    # Check a controller file to make sure that complex model creation should not exist in controller, should be replaced with factory method.
+  module Reviews
+    # Review a controller file to make sure that complex model creation should not exist in controller, should be replaced with factory method.
     #
     # See the best practice details here http://rails-bestpractices.com/posts/6-replace-complex-creation-with-factory-method.
     #
     # Implementation:
     #
-    # Prepare process:
-    #   none
-    #
     # Review process:
     #   check all method defines in the controller files,
     #   if there are multiple attribute assignments apply to one subject,
     #   and the subject is a local variable or an instance variable,
     #   and after them there is a call node with message :save or :save!,
     #   then these attribute assignments are complex creation, should be replaced with factory method.
-    class ReplaceComplexCreationWithFactoryMethodCheck < Check
+    class ReplaceComplexCreationWithFactoryMethodReview < Review
       def url
         "http://rails-bestpractices.com/posts/6-replace-complex-creation-with-factory-method"
       end
 
-      def interesting_review_nodes
+      def interesting_nodes
         [:defn]
       end
 
-      def interesting_review_files
+      def interesting_files
         CONTROLLER_FILES
       end
 
@@ -36,14 +33,14 @@ module RailsBestPractices
         @attrasgn_count = options['attribute_assignment_count'] || 2
       end
 
-      # check method define node to see if there are multiple attribute assignments, more than @attrasgn_count, on one local variable or instance variable before save in review process.
+      # check method define node to see if there are multiple attribute assignments, more than @attrasgn_count, on one local variable or instance variable before save.
       #
       # it wll check every attrasgn nodes in method define node,
       # if there are multiple attrasgn nodes who have the same subject,
       # and the subject is a local variable or an instance variable,
       # and after them, there is a call node with message :save or :save!,
       # then these attribute assignments are complex creation, should be replaced with factory method.
-      def review_start_defn(node)
+      def start_defn(node)
         node.recursive_children do |child_node|
           case child_node.node_type
           when :attrasgn

data/lib/rails_best_practices/{checks/replace_instance_variable_with_local_variable_check.rb → reviews/replace_instance_variable_with_local_variable_review.rb}

@@ -1,36 +1,33 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
-    # Check a partail view file to make sure there is no instance variable.
+  module Reviews
+    # Review a partail view file to make sure there is no instance variable.
     #
     # See the best practice details here http://rails-bestpractices.com/posts/27-replace-instance-variable-with-local-variable.
     #
     # Implementation:
     #
-    # Prepare process:
-    #   none
-    #
     # Review process:
     #   check all instance variable in partial view files,
     #   if exist, then they should be replaced with local variable
-    class ReplaceInstanceVariableWithLocalVariableCheck < Check
+    class ReplaceInstanceVariableWithLocalVariableReview < Review
       def url
         "http://rails-bestpractices.com/posts/27-replace-instance-variable-with-local-variable"
       end
 
-      def interesting_review_nodes
+      def interesting_nodes
         [:ivar]
       end
 
-      def interesting_review_files
+      def interesting_files
         PARTIAL_VIEW_FILES
       end
 
       # check ivar node in partial view file,
       # it is an instance variable, and should be replaced with local variable.
-      def review_start_ivar(node)
+      def start_ivar(node)
         add_error "replace instance variable with local variable"
       end
     end

data/lib/rails_best_practices/reviews/review.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+require 'rails_best_practices/core/check'
+require 'rails_best_practices/core/error'
+
+module RailsBestPractices
+  module Reviews
+    # A Review class that takes charge of reviewing one rails best practice.
+    class Review < Core::Check
+      attr_reader :errors
+
+      def initialize
+        super
+        @errors = []
+      end
+
+      # add error if source code violates rails best practice.
+      #   error is the string message for violation of the rails best practice
+      #   file is the filename of source code
+      #   line is the line number of the source code which is reviewing
+      def add_error(error, file = @node.file, line = @node.line)
+        @errors << RailsBestPractices::Core::Error.new("#{file}", "#{line}", error, url)
+      end
+
+      # remember use count for the local or instance variable in the call or attrasgn node.
+      #
+      # find the local variable or instance variable in the call or attrasgn node,
+      # then save it to as key in @variable_use_count hash, and add the call count (hash value).
+      def remember_variable_use_count(node)
+        variable_node = variable(node)
+        if variable_node
+          variable_use_count[variable_node] ||= 0
+          variable_use_count[variable_node] += 1
+        end
+      end
+
+      # return @variable_use_count hash.
+      def variable_use_count
+        @variable_use_count ||= {}
+      end
+
+      # reset @variable_use_count hash.
+      def reset_variable_use_count
+        @variable_use_count = nil
+      end
+
+      # find local variable or instance variable in the most inner call node, e.g.
+      #
+      # if the call node is
+      #
+      #     s(:call, s(:ivar, :@post), :editors, s(:arglist)),
+      #
+      # or it is
+      #
+      #     s(:call,
+      #       s(:call, s(:ivar, :@post), :editors, s(:arglist)),
+      #       :include?,
+      #       s(:arglist, s(:call, nil, :current_user, s(:arglist)))
+      #     )
+      #
+      # then the variable both are s(:ivar, :@post).
+      #
+      def variable(node)
+        while node.subject.node_type == :call
+          node = node.subject
+        end
+        subject_node = node.subject
+        if [:ivar, :lvar].include?(subject_node.node_type) and subject_node[1] != :_erbout
+          subject_node
+        else
+          nil
+        end
+      end
+
+      # get the model associations from Prepares.
+      #
+      # @return [Hash]
+      def model_associations
+        @model_associations ||= Prepares.model_associations
+      end
+
+      # compare two sexp nodes' to_s.
+      #
+      #     equal?(":test", :test) => true
+      #     equai?("@test", :test) => true
+      def equal?(node, expected_node)
+        actual = node.to_s.downcase
+        expected = expected_node.to_s.downcase
+        actual == expected || actual == ':' + expected || actual == '@' + expected
+      end
+    end
+  end
+end