rails_best_practices 0.10.1 → 1.0.0

data/lib/rails_best_practices/reviews/move_model_logic_into_model_review.rb

@@ -11,8 +11,8 @@ module RailsBestPractices
     #
     # 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,
+    #   if there are multiple method calls apply to one subject,
+    #   and the subject is a variable,
     #   then they are complex model logic, and they should be moved into model.
     class MoveModelLogicIntoModelReview < Review
       def url
@@ -20,7 +20,7 @@ module RailsBestPractices
       end
 
       def interesting_nodes
-        [:defn]
+        [:def]
       end
 
       def interesting_files
@@ -32,14 +32,14 @@ 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.
+      # check method define node to see if there are multiple method calls on one 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,
+      # it will check every call nodes,
+      # if there are multiple call nodes who have the same subject,
+      # and the subject is a variable,
       # then these method calls and attribute assignments should be moved into model.
-      def start_defn(node)
-        node.grep_nodes(:node_type => [:call, :attrasgn]) do |child_node|
+      def start_def(node)
+        node.grep_nodes(:sexp_type => [:call, :assign]) do |child_node|
           remember_variable_use_count(child_node)
         end
 

data/lib/rails_best_practices/reviews/needless_deep_nesting_review.rb

@@ -10,20 +10,17 @@ module RailsBestPractices
     # Implementation:
     #
     # Review process:
-    #   chech all iter nodes in route file.
+    #   chech all method_add_block nodes in route file.
     #
-    #   it is a recursively check in :iter node,
+    #   it is a recursively check in method_add_block node,
     #
-    #   if it is a :iter node,
+    #   if it is a method_add_block node,
     #   increment @counter at the beginning of resources,
     #   decrement @counter at the end of resrouces,
-    #   recursively check nodes in iter's block body.
+    #   recursively check nodes in block body.
     #
-    #   if it is a :block node,
-    #   then recursively check all child nodes in block node.
-    #
-    #   if it is a :call node,
-    #   and the message of the node is :resources or :resource,
+    #   if the child node is a command_call or command node,
+    #   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 NeedlessDeepNestingReview < Review
@@ -32,7 +29,7 @@ module RailsBestPractices
       end
 
       def interesting_nodes
-        [:call, :iter]
+        [:method_add_block]
       end
 
       def interesting_files
@@ -45,83 +42,42 @@ module RailsBestPractices
         @nested_count = options['nested_count'] || 2
       end
 
-      # check all iter node.
-      #
-      # It is a recursively check,
+      # check all method_add_block node.
       #
-      # if it is a :iter node, like
-      #
-      #     resources posts do
-      #       ...
-      #     end
+      # It is a recursively check, if it is a method_add_block node,
       # increment @counter at the beginning of resources,
-      # decrement @counter at the end of iter resources,
+      # decrement @counter at the end of method_add_block resources,
       # recursively check the block body.
       #
-      # if it is a :block node, like
-      #
-      #     resources :posts do
-      #       resources :comments
-      #       resources :votes
-      #     end
-      #
-      # just recursively check each child node in block node.
-      #
-      # if it is a :call node with message :resources or :resource, like
-      #
-      #     resources :comments
-      #
+      # if the child node is a command_call or command node with message "resources" or "resource",
       # test if the @counter is greater than or equal to @nested_count,
       # if so, it is a needless deep nesting.
-      def start_iter(node)
+      def start_method_add_block(node)
+        @file = node.file
         recursively_check(node)
       end
 
       private
         # check nested route.
         #
-        # if the node type is :iter,
-        # and the subject of the node is with message :resources or :resource, like
-        #
-        #     s(:iter,
-        #       s(:call, nil, :resources,
-        #         s(:arglist, s(:lit, :posts))
-        #       ),
-        #       nil,
-        #       s(:call, nil, :resources,
-        #         s(:arglist, s(:lit, :comments))
-        #       )
-        #     )
-        #
+        # if the subject of the method_add_block is with message "resources" or "resource",
         # then increment the @counter, recursively check the block body, and decrement the @counter.
         #
-        # if the node type is :block, it is the block body of :iter node, like
-        #
-        #     s(:block,
-        #       s(:call, nil, :resources, s(:arglist, s(:lit, :comments))),
-        #       s(:call, nil, :resources, s(:arglist, s(:lit, :votes)))
-        #     )
-        #
-        # then check the each child node in the block.
-        #
-        # if the node type is :call,
-        # and the message of node is :resources or :resource, like
-        #
-        #     s(:call, nil, :resources, s(:arglist, s(:lit, :comments)))
-        #
+        # if the node type is command_call or command,
+        # and its message is resources or resource,
         # then check if @counter is greater than or equal to @nested_count,
         # if so, it is the needless deep nesting.
         def recursively_check(node)
-          if :iter == node.node_type && :resources == node.subject.message
-            options = eval(node.subject.arguments[2].to_s)
-            return if options && options["shallow"] == true
+          if [:command_call, :command].include?(node[1].sexp_type) && ["resources", "resource"].include?(node[1].message.to_s)
+            hash_node = node[1].arguments.grep_node(:sexp_type => :bare_assoc_hash)
+            return if hash_node && "true" == hash_node.hash_value("shallow").to_s
             @counter += 1
-            recursively_check(node.body)
+            node.block.statements.each do |stmt_node|
+              recursively_check(stmt_node)
+            end
             @counter -= 1
-          elsif :block == node.node_type
-            node.children.each { |child_node| recursively_check(child_node) }
-          elsif :call == node.node_type && [:resources, :resource].include?(node.message)
-            add_error "needless deep nesting (nested_count > #{@nested_count})", node.file, node.line if @counter >= @nested_count
+          elsif [:command_call, :command].include?(node.sexp_type) && ["resources", "resource"].include?(node.message.to_s)
+            add_error "needless deep nesting (nested_count > #{@nested_count})", @file, node.line if @counter >= @nested_count
           end
         end
     end

data/lib/rails_best_practices/reviews/not_use_default_route_review.rb

@@ -10,7 +10,7 @@ module RailsBestPractices
     # Implementation:
     #
     # Review process:
-    #   check all method call to see if any method call is the same as rails default route.
+    #   check all method command_call or command node to see if it is the same as rails default route.
     #
     #     map.connect ':controller/:action/:id'
     #     map.connect ':controller/:action/:id.:format'
@@ -24,33 +24,26 @@ module RailsBestPractices
       end
 
       def interesting_nodes
-        [:call]
+        [:command_call, :command]
       end
 
       def interesting_files
         ROUTE_FILE
       end
 
-      # check all method calls, it just compare with rails default route
-      #
-      # rails2
-      #
-      #     s(:call, s(:lvar, :map), :connect,
-      #       s(:arglist, s(:str, ":controller/:action/:id"))
-      #     )
-      #     s(:call, s(:lvar, :map), :connect,
-      #       s(:arglist, s(:str, ":controller/:action/:id.:format"))
-      #     )
-      #
-      # rails3
-      #
-      #     s(:call, nil, :match,
-      #       s(:arglist, s(:str, ":controller(/:action(/:id(.:format)))"))
-      #     )
-      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
+      # check all command call nodes, compare with rails2 default route
+      def start_command_call(node)
+        if "map" == node.subject.to_s && "connect" == node.message.to_s &&
+          (":controller/:action/:id" == node.arguments.all[0].to_s ||
+           ":controller/:action/:id.:format" == node.arguments.all[0].to_s)
+          add_error "not use default route"
+        end
+      end
+
+      # check all command nodes, compare with rails3 default route
+      def start_command(node)
+        if "match" == node.message.to_s &&
+          ":controller(/:action(/:id(.:format)))" == node.arguments.all[0].to_s
           add_error "not use default route"
         end
       end

data/lib/rails_best_practices/reviews/overuse_route_customizations_review.rb

@@ -14,29 +14,29 @@ module RailsBestPractices
     #
     #   for rails2
     #
-    #   check all call nodes in route file.
-    #   if the message of call node is resources,
-    #   and the second argument of call node is a hash,
+    #   check all command_call nodes in route file.
+    #   if the message of command_call node is resources,
+    #   and the second argument of command_call node is a hash,
     #   and the count of the pair (key/value) in hash is greater than @customize_count,
     #   then these custom routes are overuse.
     #
     #   for rails3
     #
-    #   check all iter nodes in route file.
-    #   if the subject of iter node is with message resources,
-    #   and in the block body of iter node, there are more than @customize_count call nodes,
-    #   whose message is :get, :post, :update or :delete,
+    #   check all method_add_block nodes in route file.
+    #   if the subject of method_add_block node is with message resources,
+    #   and in the block body of method_add_block node, there are more than @customize_count command nodes,
+    #   whose message is get, post, update or delete,
     #   then these custom routes are overuse.
     class OveruseRouteCustomizationsReview < Review
 
-      VERBS = [:get, :post, :update, :delete]
+      VERBS = %w(get post update delete)
 
       def url
         "http://rails-bestpractices.com/posts/10-overuse-route-customizations"
       end
 
       def interesting_nodes
-        [:call, :iter]
+        [:command_call, :method_add_block]
       end
 
       def interesting_files
@@ -48,120 +48,60 @@ 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.
+      # check command_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,
+      # if the message of call node is "resources",
       # and the second argument of call node is a hash,
-      # and the count of the pair (key/value) in hash is greater than @customize_count, like
-      #
-      #     map.resources :posts, :member => { :create_comment => :post,
-      #                                        :update_comment => :update,
-      #                                        :delete_comment => :delete },
-      #                           :collection => { :comments => :get }
-      #
+      # and the count of the pair (key/value) in hash is greater than @customize_count,
       # then they are overuse route customizations.
-      def start_call(node)
+      def start_command_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.
+      # check method_add_block 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,
-      # and in the block body of iter node, there are more than @customize_count call nodes,
-      # whose message is :get, :post, :update or :delete, like
-      #
-      #     resources :posts do
-      #       member do
-      #         post :create_comment
-      #         update :update_comment
-      #         delete :delete_comment
-      #       end
-      #
-      #       collection do
-      #         get :comments
-      #       end
-      #     end
-      #
+      # if the subject of method_add_block node is with message "resources",
+      # and in the block body of method_add_block node, there are more than @customize_count call nodes,
+      # whose message is :get, :post, :update or :delete,
       # then they are overuse route customizations.
-      def start_iter(node)
+      def start_method_add_block(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
+          add_error "overuse route customizations (customize_count > #{@customize_count})", node.file, node.line
         end
       end
 
       private
-        # check call node to calculate the count of member and collection custom routes.
+        # check command_call node to calculate the count of member and collection custom routes.
         # this is for rails2 syntax.
         #
-        # if the message of call node is :resources,
+        # if the message of command_call node is "resources",
         # and the second argument is a hash,
         # then calculate the pair (key/value) count,
         # it is just the count of member and collection custom routes.
-        #
-        #     s(:call, s(:lvar, :map), :resources,
-        #       s(:arglist,
-        #         s(:lit, :posts),
-        #         s(:hash,
-        #           s(:lit, :member),
-        #           s(:hash,
-        #             s(:lit, :create_comment),
-        #             s(:lit, :post),
-        #             s(:lit, :update_comment),
-        #             s(:lit, :update),
-        #             s(:lit, :delete_comment),
-        #             s(:lit, :delete)
-        #           ),
-        #           s(:lit, :collection),
-        #           s(:hash,
-        #             s(:lit, :comments),
-        #             s(:lit, :get)
-        #           )
-        #         )
-        #       )
-        #     )
         def member_and_collection_count_for_rails2(node)
-          if :resources == node.message
-            hash_node = node.arguments[2]
-            if hash_node
-              return (hash_node.grep_nodes_count(:node_type => :lit) - hash_node.grep_nodes_count(:node_type => :hash)) / 2
+          if "resources" == node.message.to_s
+            hash_node = node.arguments.all[1]
+            if hash_node && :bare_assoc_hash == hash_node.sexp_type
+              member_node = hash_node.hash_value("member")
+              collection_node = hash_node.hash_value("collection")
+              return (member_node.hash_size || member_node.array_size) + (collection_node.hash_size || collection_node.array_size)
             end
           end
           0
         end
 
-        # check iter node to calculate the count of member and collection custom routes.
+        # check method_add_block node to calculate the count of member and collection custom routes.
         # this is for rails3 syntax.
         #
-        # if its subject is with message :resources,
-        # then calculate the count of call nodes, whose message is :get, :post, :update or :delete,
+        # if its subject is with message "resources",
+        # then calculate the count of call nodes, whose message is get, post, update or delete,
         # it is just the count of member and collection custom routes.
-        #
-        #     s(:iter,
-        #       s(:call, nil, :resources, s(:arglist, s(:lit, :posts))),
-        #       nil,
-        #       s(:block,
-        #         s(:iter,
-        #           s(:call, nil, :member, s(:arglist)),
-        #           nil,
-        #           s(:block,
-        #             s(:call, nil, :post, s(:arglist, s(:lit, :create_comment))),
-        #             s(:call, nil, :post, s(:arglist, s(:lit, :update_comment))),
-        #             s(:call, nil, :post, s(:arglist, s(:lit, :delete_comment)))
-        #           )
-        #         ),
-        #         s(:iter,
-        #           s(:call, nil, :collection, s(:arglist)),
-        #           nil,
-        #           s(:call, nil, :get, s(:arglist, s(:lit, :comments)))
-        #         )
-        #       )
-        #     )
         def member_and_collection_count_for_rails3(node)
-          :resources == node.subject.message ? node.grep_nodes_count(:node_type => :call, :message => VERBS) : 0
+          "resources" == node[1].message.to_s ? node.grep_nodes_count(:sexp_type => :command, :message => VERBS) : 0
         end
     end
   end

data/lib/rails_best_practices/reviews/remove_empty_helpers_review.rb

@@ -25,8 +25,10 @@ module RailsBestPractices
       end
 
       # check the body of module node, if it is nil, then it should be removed.
-      def start_module(module_node)
-        add_error "remove empty helpers" if module_node.body.is_a?(Core::Nil)
+      def start_module(node)
+        if s(:bodystmt, s(:stmts_add, s(:stmts_new), s(:void_stmt)), nil, nil, nil) == node.body
+          add_error "remove empty helpers", node.file, node.line
+        end
       end
     end
   end

data/lib/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review.rb

@@ -12,8 +12,8 @@ module RailsBestPractices
     # 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!,
+    #   and the subject is a 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 ReplaceComplexCreationWithFactoryMethodReview < Review
       def url
@@ -21,7 +21,7 @@ module RailsBestPractices
       end
 
       def interesting_nodes
-        [:defn]
+        [:def]
       end
 
       def interesting_files
@@ -30,21 +30,23 @@ module RailsBestPractices
 
       def initialize(options = {})
         super()
-        @attrasgn_count = options['attribute_assignment_count'] || 2
+        @assigns_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.
+      # check method define node to see if there are multiple assignments, more than @assigns_count, on one 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!,
+      # if there are multiple assign nodes who have the same subject,
+      # and the subject is a 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 start_defn(node)
+      def start_def(node)
         node.recursive_children do |child_node|
-          case child_node.node_type
-          when :attrasgn
-            remember_variable_use_count(child_node)
+          case child_node.sexp_type
+          when :assign
+            if :"." == child_node.subject[2]
+              remember_variable_use_count(child_node)
+            end
           when :call
             check_variable_save(child_node)
           else
@@ -54,14 +56,14 @@ module RailsBestPractices
       end
 
       private
-        # check the call node to see if it is with message :save or :save!,
-        # and the count attribute assignment on the subject of the call node is greater than @attrasgn_count defined,
+        # check the call node to see if it is with message "save" or "save!",
+        # and the count attribute assignment on the subject of the call node is greater than @assign_count defined,
         # then it is a complex creation, should be replaced with factory method.
         def check_variable_save(node)
-          if [:save, :save!].include? node.message
-            variable = node.subject
-            if variable_use_count[variable].to_i > @attrasgn_count
-              add_error "replace complex creation with factory method (#{variable} attribute_assignment_count > #{@attrasgn_count})"
+          if ["save", "save!"].include? node.message.to_s
+            variable = node.subject.to_s
+            if variable_use_count[variable].to_i > @assigns_count
+              add_error "replace complex creation with factory method (#{variable} attribute_assignment_count > #{@assigns_count})"
             end
           end
         end