rails_best_practices 1.10.1 → 1.11.0

data/lib/rails_best_practices/reviews/restrict_auto_generated_routes_review.rb

@@ -17,22 +17,19 @@ module RailsBestPractices
     class RestrictAutoGeneratedRoutesReview < Review
       interesting_nodes :command, :command_call, :method_add_block
       interesting_files ROUTE_FILES
+      url "http://rails-bestpractices.com/posts/86-restrict-auto-generated-routes"
 
       RESOURCE_METHODS = ["show", "new", "create", "edit", "update", "destroy"]
       RESOURCES_METHODS = RESOURCE_METHODS + ["index"]
 
-      def url
-        "http://rails-bestpractices.com/posts/86-restrict-auto-generated-routes"
-      end
-
       def initialize
         super
         @namespaces = []
         @resource_controllers = []
       end
 
-      # check if the generated routes have the corresponding actions in controller for rails3 routes.
-      def start_command(node)
+      # check if the generated routes have the corresponding actions in controller for rails routes.
+      add_callback :start_command, :start_command_call do |node|
         if "resources" == node.message.to_s
           check_resources(node)
           @resource_controllers << node.arguments.all.first.to_s
@@ -42,7 +39,7 @@ module RailsBestPractices
         end
       end
 
-      def end_command(node)
+      add_callback :end_command do |node|
         if "resources" == node.message.to_s
           @resource_controllers.pop
         elsif "resource" == node.message.to_s
@@ -51,37 +48,32 @@ module RailsBestPractices
       end
 
       # remember the namespace.
-      def start_method_add_block(node)
+      add_callback :start_method_add_block do |node|
         case node.message.to_s
         when "namespace"
-          return unless check_method_add_block?(node)
-          @namespaces << node.arguments.all.first.to_s
+          @namespaces << node.arguments.all.first.to_s if check_method_add_block?(node)
         when "resources", "resource"
-          return unless check_method_add_block?(node)
-          @resource_controllers << node.arguments.all.first.to_s
+          @resource_controllers << node.arguments.all.first.to_s if check_method_add_block?(node)
         else
         end
       end
 
       # end of namespace call.
-      def end_method_add_block(node)
-        return unless check_method_add_block?(node)
-
-        case node.message.to_s
-        when "namespace"
-          @namespaces.pop
-        when "resources", "resource"
-          @resource_controllers.pop
+      add_callback :end_method_add_block do |node|
+        if check_method_add_block?(node)
+          case node.message.to_s
+          when "namespace"
+            @namespaces.pop
+          when "resources", "resource"
+            @resource_controllers.pop
+          end
         end
       end
 
       def check_method_add_block?(node)
-        :command == node[1].sexp_type || (:command_call == node[1].sexp_type && "map" != node.subject.to_s)
+        :command == node[1].sexp_type || (:command_call == node[1].sexp_type && "map" != node.receiver.to_s)
       end
 
-      # check if the generated routes have the corresponding actions in controller for rails2 routes.
-      alias_method :start_command_call, :start_command
-
       private
         # check resources call, if the routes generated by resources does not exist in the controller.
         def check_resources(node)
@@ -143,7 +135,7 @@ module RailsBestPractices
             elsif hash_key_exist?(option_node, "except")
               if option_node.hash_value("except").to_s == "all"
                 []
-              else 
+              else
                 (methods - Array(option_node.hash_value("except").to_object))
               end
             else
@@ -165,7 +157,7 @@ module RailsBestPractices
             elsif hash_key_exist?(option_node, "except")
               if option_node.hash_value("except").to_s == "all"
                 []
-              else 
+              else
                 (methods - Array(option_node.hash_value("except").to_object))
               end
             else

data/lib/rails_best_practices/reviews/review.rb

@@ -7,9 +7,8 @@ module RailsBestPractices
     # A Review class that takes charge of reviewing one rails best practice.
     class Review < Core::Check
       # default url.
-      def url
-        "#"
-      end
+      url "#"
+
       # remember use count for the variable in the call or assign node.
       #
       # find the variable in the call or assign node,
@@ -35,11 +34,11 @@ module RailsBestPractices
 
       # find variable in the call or field node.
       def variable(node)
-        while [:call, :field, :method_add_arg, :method_add_block].include?(node.subject.sexp_type)
-          node = node.subject
+        while [:call, :field, :method_add_arg, :method_add_block].include?(node.receiver.sexp_type)
+          node = node.receiver
         end
-        return if [:fcall, :hash].include?(node.subject.sexp_type)
-        node.subject
+        return if [:fcall, :hash].include?(node.receiver.sexp_type)
+        node.receiver
       end
 
       # get the models from Prepares.

data/lib/rails_best_practices/reviews/simplify_render_in_controllers_review.rb

@@ -16,15 +16,12 @@ module RailsBestPractices
     class SimplifyRenderInControllersReview < Review
       interesting_nodes :command
       interesting_files CONTROLLER_FILES
-
-      def url
-        "http://rails-bestpractices.com/posts/62-simplify-render-in-controllers"
-      end
+      url "http://rails-bestpractices.com/posts/62-simplify-render-in-controllers"
 
       # check command node in the controller file,
       # if its message is render and the arguments contain a key action, template or file,
       # then it should be replaced by simplified syntax.
-      def start_command(node)
+      add_callback :start_command do |node|
         if "render" == node.message.to_s
           keys = node.arguments.all.first.hash_keys
           if keys && keys.size == 1 &&

data/lib/rails_best_practices/reviews/simplify_render_in_views_review.rb

@@ -15,17 +15,14 @@ module RailsBestPractices
     class SimplifyRenderInViewsReview < Review
       interesting_nodes :command
       interesting_files VIEW_FILES
+      url "http://rails-bestpractices.com/posts/61-simplify-render-in-views"
 
       VALID_KEYS = %w(object collection locals)
 
-      def url
-        "http://rails-bestpractices.com/posts/61-simplify-render-in-views"
-      end
-
       # check command node in view file,
       # if its message is render and the arguments contain a key partial,
       # then it should be replaced by simplified syntax.
-      def start_command(node)
+      add_callback :start_command do |node|
         if "render" == node.message.to_s
           hash_node =  node.arguments.all.first
           if hash_node && :bare_assoc_hash == hash_node.sexp_type &&

data/lib/rails_best_practices/reviews/use_before_filter_review.rb

@@ -16,10 +16,7 @@ module RailsBestPractices
     class UseBeforeFilterReview < Review
       interesting_nodes :class
       interesting_files CONTROLLER_FILES
-
-      def url
-        "http://rails-bestpractices.com/posts/22-use-before_filter"
-      end
+      url "http://rails-bestpractices.com/posts/22-use-before_filter"
 
       def initialize(options = {})
         super()
@@ -31,7 +28,7 @@ module RailsBestPractices
       # it will check every def nodes in the class node until protected or private identification,
       # if there are defn nodes who have the same first code line,
       # then these duplicated first code lines should be moved to before_filter.
-      def start_class(node)
+      add_callback :start_class do |node|
         @first_sentences = {}
 
         node.body.statements.each do |statement_node|

data/lib/rails_best_practices/reviews/use_model_association_review.rb

@@ -13,26 +13,23 @@ module RailsBestPractices
     #   check model define nodes in all controller files,
     #   if there is an attribute assignment node with message xxx_id=,
     #   and after it, there is a call node with message "save" or "save!",
-    #   and the subjects of attribute assignment node and call node are the same,
+    #   and the receivers of attribute assignment node and call node are the same,
     #   then model association should be used instead of xxx_id assignment.
     class UseModelAssociationReview < Review
       interesting_nodes :def
       interesting_files CONTROLLER_FILES
-
-      def url
-        "http://rails-bestpractices.com/posts/2-use-model-association"
-      end
+      url "http://rails-bestpractices.com/posts/2-use-model-association"
 
       # check method define nodes to see if there are some attribute assignments that can use model association instead.
       #
       # it will check attribute assignment node with message xxx_id=, and call node with message "save" or "save!"
       #
       # 1. if there is an attribute assignment node with message xxx_id=,
-      #    then remember the subject of attribute assignment node.
+      #    then remember the receiver of attribute assignment node.
       # 2. after assignment, if there is a call node with message "save" or "save!",
-      #    and the subject of call node is one of the subject of attribute assignment node,
+      #    and the receiver of call node is one of the receiver of attribute assignment node,
       #    then the attribute assignment should be replaced by using model association.
-      def start_def(node)
+      add_callback :start_def do |node|
         @assignments = {}
         node.recursive_children do |child|
           case child.sexp_type
@@ -48,21 +45,21 @@ module RailsBestPractices
 
       private
         # check an attribute assignment node, if its message is xxx_id,
-        # then remember the subject of the attribute assignment in @assignments.
+        # then remember the receiver of the attribute assignment in @assignments.
         def attribute_assignment(node)
           if node.left_value.message.to_s =~ /_id$/
-            subject = node.left_value.subject.to_s
-            @assignments[subject] = true
+            receiver = node.left_value.receiver.to_s
+            @assignments[receiver] = true
           end
         end
 
         # check a call node with message "save" or "save!",
-        # if the subject of call node exists in @assignments,
+        # if the receiver of call node exists in @assignments,
         # then the attribute assignment should be replaced by using model association.
         def call_assignment(node)
           if ["save", "save!"].include? node.message.to_s
-            subject = node.subject.to_s
-            add_error "use model association (for #{subject})" if @assignments[subject]
+            receiver = node.receiver.to_s
+            add_error "use model association (for #{receiver})" if @assignments[receiver]
           end
         end
     end

data/lib/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review.rb

@@ -17,26 +17,29 @@ module RailsBestPractices
     class UseMultipartAlternativeAsContentTypeOfEmailReview < Review
       interesting_nodes :class, :def
       interesting_files MAILER_FILES
-
-      def url
-        "http://rails-bestpractices.com/posts/41-use-multipart-alternative-as-content_type-of-email"
-      end
+      url "http://rails-bestpractices.com/posts/41-use-multipart-alternative-as-content_type-of-email"
 
       # check class node to remember the ActionMailer class name.
-      def start_class(node)
+      add_callback :start_class do |node|
         @klazz_name = node.class_name.to_s
       end
 
       # check def node and find if the corresponding views exist or not?
-      def start_def(node)
+      add_callback :start_def do |node|
         name = node.method_name.to_s
-        return unless deliver_method?(name)
-        if rails2_canonical_mailer_views?(name) || rails3_canonical_mailer_views?(name)
+        if deliver_method?(name) && rails_canonical_mailer_views?(name)
           add_error("use multipart/alternative as content_type of email")
         end
       end
 
       private
+        # check if rails's syntax mailer views are canonical.
+        #
+        # @param [String] name method name in action_mailer
+        def rails_canonical_mailer_views?(name)
+          rails2_canonical_mailer_views?(name) || rails3_canonical_mailer_views?(name)
+        end
+
         # check if rails2's syntax mailer views are canonical.
         #
         # @param [String] name method name in action_mailer

data/lib/rails_best_practices/reviews/use_observer_review.rb

@@ -22,10 +22,7 @@ module RailsBestPractices
     class UseObserverReview < Review
       interesting_nodes :def, :command
       interesting_files MODEL_FILES
-
-      def url
-        "http://rails-bestpractices.com/posts/19-use-observer"
-      end
+      url "http://rails-bestpractices.com/posts/19-use-observer"
 
       def initialize
         super
@@ -36,7 +33,7 @@ module RailsBestPractices
       #
       # if it is a callback definition,
       # then remember its callback methods.
-      def start_command(node)
+      add_callback :start_command do |node|
         remember_callback(node)
       end
 
@@ -45,7 +42,7 @@ module RailsBestPractices
       # if it is callback method,
       # and there is a actionmailer deliver call in the method define node,
       # then it should be replaced by using observer.
-      def start_def(node)
+      add_callback :start_def do |node|
         if callback_method?(node) && deliver_mailer?(node)
           add_error "use observer"
         end
@@ -73,22 +70,22 @@ module RailsBestPractices
         # for rails2
         #
         # if the message of call node is deliver_xxx,
-        # and the subject of the call node exists in @callbacks,
+        # and the receiver of the call node exists in @callbacks,
         #
         # for rails3
         #
         # if the message of call node is deliver,
-        # and the subject of the call node is with subject node who exists in @callbacks,
+        # and the receiver of the call node is with receiver node who exists in @callbacks,
         #
         # then the call node is actionmailer deliver call.
         def deliver_mailer?(node)
           node.grep_nodes(sexp_type: :call) do |child_node|
             # rails2 actionmailer deliver
-            return true if child_node.message.to_s =~ /^deliver_/ && mailers.include?(child_node.subject.to_s)
+            return true if child_node.message.to_s =~ /^deliver_/ && mailers.include?(child_node.receiver.to_s)
             # rails3 actionmailer deliver
             if "deliver" == child_node.message.to_s
-              if :method_add_arg == child_node.subject.sexp_type &&
-                mailers.include?(child_node.subject[1].subject.to_s)
+              if :method_add_arg == child_node.receiver.sexp_type &&
+                mailers.include?(child_node.receiver[1].receiver.to_s)
                 return true
               end
             end

data/lib/rails_best_practices/reviews/use_parentheses_in_method_def_review.rb

@@ -14,7 +14,7 @@ module RailsBestPractices
       interesting_files ALL_FILES
 
       # check def node to see if parameters are wrapped by parentheses.
-      def start_def(node)
+      add_callback :start_def do |node|
         if no_parentheses_around_parameters?(node) && has_parameters?(node)
           add_error("use parentheses around parameters in method definitions")
         end

data/lib/rails_best_practices/reviews/use_query_attribute_review.rb

@@ -11,33 +11,30 @@ module RailsBestPractices
     #
     # Review process:
     #   check all method calls within conditional statements, like @user.login.nil?
-    #   if their subjects are one of the model names
+    #   if their receivers are one of the model names
     #   and their messages of first call are not pluralize and not in any of the association names
     #   and their messages of second call are one of nil?, blank?, present?, or they are == ""
     #   then you can use query attribute instead.
     class UseQueryAttributeReview < Review
       interesting_nodes :if, :unless, :elsif
       interesting_files ALL_FILES
+      url "http://rails-bestpractices.com/posts/56-use-query-attribute"
 
       QUERY_METHODS = %w(nil? blank? present?)
 
-      def url
-        "http://rails-bestpractices.com/posts/56-use-query-attribute"
-      end
-
       # check if node to see whose conditional statement nodes contain nodes that can use query attribute instead.
       #
       # it will check every call nodes in the if nodes. If the call node is
       #
       # 1. two method calls, like @user.login.nil?
-      # 2. the subject is one of the model names
+      # 2. the receiver is one of the model names
       # 3. the message of first call is the model's attribute,
       #    the message is not in any of associations name and is not pluralize
       # 4. the message of second call is one of nil?, blank? or present? or
       #    the message is == and the argument is ""
       #
       # then the call node can use query attribute instead.
-      def start_if(node)
+      add_callback :start_if, :start_unless, :start_elsif do |node|
         all_conditions = if node.conditional_statement == node.conditional_statement.all_conditions
           [node.conditional_statement]
         else
@@ -45,17 +42,14 @@ module RailsBestPractices
         end
         all_conditions.each do |condition_node|
           if query_attribute_node = query_attribute_node(condition_node)
-            subject_node = query_attribute_node.subject
-            add_error "use query attribute (#{subject_node.subject}.#{subject_node.message}?)",
+            receiver_node = query_attribute_node.receiver
+            add_error "use query attribute (#{receiver_node.receiver}.#{receiver_node.message}?)",
               node.file,
               query_attribute_node.line
           end
         end
       end
 
-      alias_method :start_unless, :start_if
-      alias_method :start_elsif, :start_if
-
       private
         # recursively check conditional statement nodes to see if there is a call node that may be
         # possible query attribute.
@@ -81,7 +75,7 @@ module RailsBestPractices
         #
         # if the node contains two method calls, e.g. @user.login.nil?
         #
-        # for the first call, the subject should be one of the class names and
+        # for the first call, the receiver should be one of the class names and
         # the message should be one of the attribute name.
         #
         # for the second call, the message should be one of nil?, blank? or present? or
@@ -89,23 +83,23 @@ module RailsBestPractices
         #
         # the node that may use query attribute.
         def possible_query_attribute?(node)
-          return false unless :call == node.subject.sexp_type
+          return false unless :call == node.receiver.sexp_type
           variable_node = variable(node)
-          message_node = node.grep_node(subject: variable_node.to_s).message
+          message_node = node.grep_node(receiver: variable_node.to_s).message
 
           is_model?(variable_node) && model_attribute?(variable_node, message_node.to_s) &&
             (QUERY_METHODS.include?(node.message.to_s) || compare_with_empty_string?(node))
         end
 
-        # check if the subject is one of the models.
+        # check if the receiver is one of the models.
         def is_model?(variable_node)
           return false if variable_node.const?
           class_name = variable_node.to_s.sub(/^@/, '').classify
           models.include?(class_name)
         end
 
-        # check if the subject and message is one of the model's attribute.
-        # the subject should match one of the class model name, and the message should match one of attribute name.
+        # check if the receiver and message is one of the model's attribute.
+        # the receiver should match one of the class model name, and the message should match one of attribute name.
         def model_attribute?(variable_node, message)
           class_name = variable_node.to_s.sub(/^@/, '').classify
           attribute_type = model_attributes.get_attribute_type(class_name, message)