rails_best_practices 1.10.1 → 1.11.0

data/lib/rails_best_practices/reviews/move_code_into_model_review.rb

@@ -10,28 +10,25 @@ module RailsBestPractices
     # Implementation:
     #
     # Review process:
-    #   check if, unless, elsif there are multiple method calls or attribute assignments apply to one subject,
-    #   and the subject is a variable, then they should be moved into model.
+    #   check if, unless, elsif there are multiple method calls or attribute assignments apply to one receiver,
+    #   and the receiver is a variable, then they should be moved into model.
     class MoveCodeIntoModelReview < Review
       interesting_nodes :if, :unless, :elsif
       interesting_files VIEW_FILES
-
-      def url
-        "http://rails-bestpractices.com/posts/25-move-code-into-model"
-      end
+      url "http://rails-bestpractices.com/posts/25-move-code-into-model"
 
       def initialize(options={})
         super()
         @use_count = options['use_count'] || 2
       end
 
-      # check if node to see whose conditional statementnodes contain multiple call nodes with same subject who is a variable.
+      # check if node to see whose conditional statementnodes contain multiple call nodes with same receiver who is a variable.
       #
       # it will check every call and assignment nodes in the conditional statement nodes.
       #
-      # if there are multiple call and assignment nodes who have the same subject,
-      # and the subject is a variable, then the conditional statement nodes should be moved into model.
-      def start_if(node)
+      # if there are multiple call and assignment nodes who have the same receiver,
+      # and the receiver is a variable, then the conditional statement nodes should be moved into model.
+      add_callback :start_if, :start_unless, :start_elsif do |node|
         node.conditional_statement.grep_nodes(sexp_type: :call) { |child_node| remember_variable_use_count(child_node) }
 
         variable_use_count.each do |variable_node, count|
@@ -40,9 +37,6 @@ module RailsBestPractices
 
         reset_variable_use_count
       end
-
-      alias_method :start_unless, :start_if
-      alias_method :start_elsif, :start_if
     end
   end
 end

data/lib/rails_best_practices/reviews/move_finder_to_named_scope_review.rb

@@ -17,24 +17,21 @@ module RailsBestPractices
     class MoveFinderToNamedScopeReview < Review
       interesting_nodes :method_add_arg
       interesting_files CONTROLLER_FILES
+      url "http://rails-bestpractices.com/posts/1-move-finder-to-named_scope"
 
       FINDERS = %w(find all first last)
 
-      def url
-        "http://rails-bestpractices.com/posts/1-move-finder-to-named_scope"
-      end
-
       # check method_add_ag 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 start_method_add_arg(node)
+      add_callback :start_method_add_arg do |node|
         add_error "move finder to named_scope" if finder?(node)
       end
 
       private
         # check if the method_add_arg node is a finder.
         #
-        # if the subject of method_add_arg node is a constant,
+        # if the receiver of method_add_arg node is a constant,
         # and the message of call method_add_arg is one of find, all, first or last,
         # and any of its arguments is a hash,
         # then it is a finder.

data/lib/rails_best_practices/reviews/move_model_logic_into_model_review.rb

@@ -11,16 +11,13 @@ module RailsBestPractices
     #
     # Review process:
     #   check all method defines in the controller files,
-    #   if there are multiple method calls apply to one subject,
-    #   and the subject is a variable,
+    #   if there are multiple method calls apply to one receiver,
+    #   and the receiver is a variable,
     #   then they are complex model logic, and they should be moved into model.
     class MoveModelLogicIntoModelReview < Review
       interesting_nodes :def
       interesting_files CONTROLLER_FILES
-
-      def url
-        "http://rails-bestpractices.com/posts/7-move-model-logic-into-the-model"
-      end
+      url "http://rails-bestpractices.com/posts/7-move-model-logic-into-the-model"
 
       def initialize(options = {})
         super()
@@ -30,10 +27,10 @@ module RailsBestPractices
       # check method define node to see if there are multiple method calls on one varialbe.
       #
       # it will check every call nodes,
-      # if there are multiple call nodes who have the same subject,
-      # and the subject is a variable,
+      # if there are multiple call nodes who have the same receiver,
+      # and the receiver is a variable,
       # then these method calls and attribute assignments should be moved into model.
-      def start_def(node)
+      add_callback :start_def do |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

@@ -26,10 +26,7 @@ module RailsBestPractices
     class NeedlessDeepNestingReview < Review
       interesting_nodes :method_add_block
       interesting_files ROUTE_FILES
-
-      def url
-        "http://rails-bestpractices.com/posts/11-needless-deep-nesting"
-      end
+      url "http://rails-bestpractices.com/posts/11-needless-deep-nesting"
 
       def initialize(options = {})
         super()
@@ -48,7 +45,7 @@ module RailsBestPractices
       # 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_method_add_block(node)
+      add_callback :start_method_add_block do |node|
         @file = node.file
         recursively_check(node)
       end
@@ -56,7 +53,7 @@ module RailsBestPractices
       private
         # check nested route.
         #
-        # if the subject of the method_add_block is with message "resources" or "resource",
+        # if the receiver 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 command_call or command,

data/lib/rails_best_practices/reviews/not_use_default_route_review.rb

@@ -21,14 +21,11 @@ module RailsBestPractices
     class NotUseDefaultRouteReview < Review
       interesting_nodes :command_call, :command
       interesting_files ROUTE_FILES
-
-      def url
-        "http://rails-bestpractices.com/posts/12-not-use-default-route-if-you-use-restful-design"
-      end
+      url "http://rails-bestpractices.com/posts/12-not-use-default-route-if-you-use-restful-design"
 
       # 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 &&
+      add_callback :start_command_call do |node|
+        if "map" == node.receiver.to_s && "connect" == node.message.to_s &&
           (":controller/:action/:id" == node.arguments.all.first.to_s ||
            ":controller/:action/:id.:format" == node.arguments.all.first.to_s)
           add_error "not use default route"
@@ -36,7 +33,7 @@ module RailsBestPractices
       end
 
       # check all command nodes, compare with rails3 default route
-      def start_command(node)
+      add_callback :start_command do |node|
         if "match" == node.message.to_s &&
           ":controller(/:action(/:id(.:format)))" == node.arguments.all.first.to_s
           add_error "not use default route"

data/lib/rails_best_practices/reviews/not_use_time_ago_in_words_review.rb

@@ -14,13 +14,10 @@ module RailsBestPractices
     class NotUseTimeAgoInWordsReview < Review
       interesting_nodes :fcall
       interesting_files VIEW_FILES, HELPER_FILES
-
-      def url
-        "http://rails-bestpractices.com/posts/105-not-use-time_ago_in_words"
-      end
+      url "http://rails-bestpractices.com/posts/105-not-use-time_ago_in_words"
 
       # check fcall node to see if its message is time_ago_in_words or distance_of_time_in_words_to_now
-      def start_fcall(node)
+      add_callback :start_fcall do |node|
         if "time_ago_in_words" == node.message.to_s || "distance_of_time_in_words_to_now" == node.message.to_s
           add_error "not use time_ago_in_words"
         end

data/lib/rails_best_practices/reviews/overuse_route_customizations_review.rb

@@ -23,20 +23,17 @@ module RailsBestPractices
     #   for rails3
     #
     #   check all method_add_block nodes in route file.
-    #   if the subject of method_add_block node is with message resources,
+    #   if the receiver 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
       interesting_nodes :command_call, :method_add_block
       interesting_files ROUTE_FILES
+      url "http://rails-bestpractices.com/posts/10-overuse-route-customizations"
 
       VERBS = %w(get post update delete)
 
-      def url
-        "http://rails-bestpractices.com/posts/10-overuse-route-customizations"
-      end
-
       def initialize(options = {})
         super()
         @customize_count = options['customize_count'] || 3
@@ -49,20 +46,20 @@ module RailsBestPractices
       # 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,
       # then they are overuse route customizations.
-      def start_command_call(node)
+      add_callback :start_command_call do |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
+          add_error "overuse route customizations (customize_count > #{@customize_count})", node.file, node.receiver.line
         end
       end
 
       # 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 method_add_block node is with message "resources",
+      # if the receiver 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_method_add_block(node)
+      add_callback :start_method_add_block do |node|
         if member_and_collection_count_for_rails3(node) > @customize_count
           add_error "overuse route customizations (customize_count > #{@customize_count})", node.file, node.line
         end
@@ -91,7 +88,7 @@ module RailsBestPractices
         # 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",
+        # if its receiver 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.
         def member_and_collection_count_for_rails3(node)

data/lib/rails_best_practices/reviews/protect_mass_assignment_review.rb

@@ -14,17 +14,14 @@ module RailsBestPractices
     class ProtectMassAssignmentReview < Review
       interesting_nodes :class
       interesting_files MODEL_FILES
-
-      def url
-        "http://rails-bestpractices.com/posts/148-protect-mass-assignment"
-      end
+      url "http://rails-bestpractices.com/posts/148-protect-mass-assignment"
 
       # check class node, grep all command nodes,
       # if config.active_record.whitelist_attributes is not set true,
       # and if none of them is with message attr_accessible or attr_protected,
       # and if not use devise or authlogic,
       # then it should add attr_accessible or attr_protected to protect mass assignment.
-      def start_class(node)
+      add_callback :start_class do |node|
         if !whitelist_attributes_config? && !rails_builtin?(node) && !devise?(node) &&
             !authlogic?(node) && is_active_record?(node)
           add_error "protect mass assignment"

data/lib/rails_best_practices/reviews/remove_empty_helpers_review.rb

@@ -14,13 +14,10 @@ module RailsBestPractices
     class RemoveEmptyHelpersReview < Review
       interesting_nodes :module
       interesting_files HELPER_FILES
-
-      def url
-        "http://rails-bestpractices.com/posts/72-remove-empty-helpers"
-      end
+      url "http://rails-bestpractices.com/posts/72-remove-empty-helpers"
 
       # check the body of module node, if it is nil, then it should be removed.
-      def start_module(node)
+      add_callback :start_module do |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

data/lib/rails_best_practices/reviews/remove_unused_methods_in_controllers_review.rb

@@ -15,7 +15,6 @@ module RailsBestPractices
     class RemoveUnusedMethodsInControllersReview < Review
       include Classable
       include Moduleable
-      include Afterable
       include Callable
       include Exceptable
       include InheritedResourcesable
@@ -33,7 +32,7 @@ module RailsBestPractices
       end
 
       # mark custom inherited_resources methods as used.
-      def end_class(node)
+      add_callback :end_class do |node|
         if @inherited_resources
           INHERITED_RESOURCES_METHODS.each do |method|
             call_method(method)
@@ -47,7 +46,7 @@ module RailsBestPractices
       end
 
       # mark corresponding action as used for cells' render and render_call.
-      def start_command(node)
+      add_callback :start_command, :start_method_add_arg do |node|
         case node.message.to_s
         when "render_cell"
           controller_name, action_name, _ = *node.arguments.all.map(&:to_s)
@@ -60,6 +59,11 @@ module RailsBestPractices
           end
         when "around_filter"
           node.arguments.all.each { |argument| mark_used(argument) }
+        when "layout"
+          first_argument = node.arguments.all.first
+          if first_argument.sexp_type == :symbol_literal
+            mark_used(first_argument)
+          end
         when "helper_method"
           node.arguments.all.each { |argument| mark_publicize(argument.to_s) }
         when "delegate"
@@ -73,10 +77,8 @@ module RailsBestPractices
         end
       end
 
-      alias :start_method_add_arg :start_command
-
       # get all unused methods at the end of review process.
-      def after_review
+      add_callback :after_check do
         @routes.each do |route|
           if "*" == route.action_name
             action_names = @controller_methods.get_methods(route.controller_name_with_namespaces).map(&:method_name)

data/lib/rails_best_practices/reviews/remove_unused_methods_in_helpers_review.rb

@@ -13,7 +13,6 @@ module RailsBestPractices
     #   then they are unused methods in helpers.
     class RemoveUnusedMethodsInHelpersReview < Review
       include Moduleable
-      include Afterable
       include Callable
       include Exceptable
 
@@ -26,7 +25,7 @@ module RailsBestPractices
       end
 
       # get all unused methods at the end of review process
-      def after_review
+      add_callback :after_check do
         @helper_methods.get_all_unused_methods.each do |method|
           if !excepted?(method)
             add_error "remove unused methods (#{method.class_name}##{method.method_name})", method.file, method.line

data/lib/rails_best_practices/reviews/remove_unused_methods_in_models_review.rb

@@ -13,7 +13,6 @@ module RailsBestPractices
     #   if not, non called methods are unused.
     class RemoveUnusedMethodsInModelsReview < Review
       include Classable
-      include Afterable
       include Callable
       include Exceptable
 
@@ -32,7 +31,7 @@ module RailsBestPractices
 
       # mark validate methods as used.
       # mark key method and value method for collection_select and grouped_collection_select.
-      def start_command(node)
+      add_callback :start_command do |node|
         arguments = node.arguments.all
         case node.message.to_s
         when "validate", "validate_on_create", "validate_on_update"
@@ -49,7 +48,7 @@ module RailsBestPractices
       end
 
       # mark key method and value method for collection_select and grouped_collection_select.
-      def start_command_call(node)
+      add_callback :start_command_call do |node|
         arguments = node.arguments.all
         case node.message.to_s
         when "collection_select"
@@ -65,7 +64,7 @@ module RailsBestPractices
 
       # mark key method and value method for options_from_collection_for_select and
       # option_groups_from_collection_for_select.
-      def start_method_add_arg(node)
+      add_callback :start_method_add_arg do |node|
         arguments = node.arguments.all
         case node.message.to_s
         when "options_from_collection_for_select"
@@ -80,7 +79,7 @@ module RailsBestPractices
       end
 
       # get all unused methods at the end of review process.
-      def after_review
+      add_callback :after_check do
         @model_methods.get_all_unused_methods.each do |method|
           if !excepted?(method) && method.method_name !~ /=$/
             add_error "remove unused methods (#{method.class_name}##{method.method_name})", method.file, method.line

data/lib/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review.rb

@@ -13,17 +13,14 @@ 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 variable,
+    #   if there are multiple attribute assignments apply to one receiver,
+    #   and the receiver 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
       interesting_nodes :def
       interesting_files CONTROLLER_FILES
-
-      def url
-        "http://rails-bestpractices.com/posts/6-replace-complex-creation-with-factory-method"
-      end
+      url "http://rails-bestpractices.com/posts/6-replace-complex-creation-with-factory-method"
 
       def initialize(options = {})
         super()
@@ -34,15 +31,15 @@ module RailsBestPractices
       # @assigns_count, on one variable before save.
       #
       # it wll check every attrasgn nodes in method define node,
-      # if there are multiple assign nodes who have the same subject,
-      # and the subject is a variable,
+      # if there are multiple assign nodes who have the same receiver,
+      # and the receiver 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_def(node)
+      add_callback :start_def do |node|
         node.recursive_children do |child_node|
           case child_node.sexp_type
           when :assign
-            if :"." == child_node.subject[2]
+            if :"." == child_node.receiver[2]
               remember_variable_use_count(child_node)
             end
           when :call
@@ -55,11 +52,11 @@ module RailsBestPractices
 
       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 @assign_count defined,
+        # and the count attribute assignment on the receiver 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.to_s
-            variable = node.subject.to_s
+            variable = node.receiver.to_s
             if variable_use_count[variable].to_i > @assigns_count
               hint = "#{variable} attribute_assignment_count > #{@assigns_count}"
               add_error "replace complex creation with factory method (#{hint})"

data/lib/rails_best_practices/reviews/replace_instance_variable_with_local_variable_review.rb

@@ -16,22 +16,11 @@ module RailsBestPractices
     class ReplaceInstanceVariableWithLocalVariableReview < Review
       interesting_nodes :var_ref, :vcall
       interesting_files PARTIAL_VIEW_FILES
-
-      def url
-        "http://rails-bestpractices.com/posts/27-replace-instance-variable-with-local-variable"
-      end
-
-      # check ivar node in partial view file,
-      # it is an instance variable, and should be replaced with local variable.
-      def start_var_ref(node)
-        if node.to_s.start_with?('@')
-          add_error "replace instance variable with local variable"
-        end
-      end
+      url "http://rails-bestpractices.com/posts/27-replace-instance-variable-with-local-variable"
 
       # check ivar node in partial view file,
       # it is an instance variable, and should be replaced with local variable.
-      def start_vcall(node)
+      add_callback :start_var_ref, :start_vcall do |node|
         if node.to_s.start_with?('@')
           add_error "replace instance variable with local variable"
         end