rails_best_practices 1.19.2 → 1.20.1

data/lib/rails_best_practices/reviews/law_of_demeter_review.rb

@@ -28,40 +28,41 @@ module RailsBestPractices
       # and the message of the receiver call node matchs one of the association name with the class name,
       # then it violates the law of demeter.
       add_callback :start_call do |node|
-        if :call == node.receiver.sexp_type && need_delegate?(node)
+        if node.receiver.sexp_type == :call && need_delegate?(node)
           add_error 'law of demeter'
         end
       end
 
       private
 
-        # check if the call node can use delegate to avoid violating law of demeter.
-        #
-        # if the receiver of receiver of the call node matchs any in model names,
-        # and the message of receiver of the call node matchs any in association names,
-        # then it needs delegate.
-        def need_delegate?(node)
-          return unless variable(node)
-          class_name = variable(node).to_s.sub('@', '').classify
-          association_name = node.receiver.message.to_s
-          association = model_associations.get_association(class_name, association_name)
-          attribute_name = node.message.to_s
-          association && ASSOCIATION_METHODS.include?(association['meta']) &&
-            is_association_attribute?(association['class_name'], association_name, attribute_name)
-        end
+      # check if the call node can use delegate to avoid violating law of demeter.
+      #
+      # if the receiver of receiver of the call node matchs any in model names,
+      # and the message of receiver of the call node matchs any in association names,
+      # then it needs delegate.
+      def need_delegate?(node)
+        return unless variable(node)
 
-        def is_association_attribute?(association_class, association_name, attribute_name)
-          if association_name =~ /able$/
-            models.each do |class_name|
-              if model_associations.is_association?(class_name, association_name.sub(/able$/, '')) ||
-                model_associations.is_association?(class_name, association_name.sub(/able$/, 's'))
-                return true if model_attributes.is_attribute?(class_name, attribute_name)
-              end
+        class_name = variable(node).to_s.sub('@', '').classify
+        association_name = node.receiver.message.to_s
+        association = model_associations.get_association(class_name, association_name)
+        attribute_name = node.message.to_s
+        association && ASSOCIATION_METHODS.include?(association['meta']) &&
+          is_association_attribute?(association['class_name'], association_name, attribute_name)
+      end
+
+      def is_association_attribute?(association_class, association_name, attribute_name)
+        if association_name =~ /able$/
+          models.each do |class_name|
+            if model_associations.is_association?(class_name, association_name.sub(/able$/, '')) ||
+                 model_associations.is_association?(class_name, association_name.sub(/able$/, 's'))
+              return true if model_attributes.is_attribute?(class_name, attribute_name)
             end
-          else
-            model_attributes.is_attribute?(association_class, attribute_name)
           end
+        else
+          model_attributes.is_attribute?(association_class, attribute_name)
         end
+      end
     end
   end
 end

data/lib/rails_best_practices/reviews/move_code_into_controller_review.rb

@@ -37,10 +37,10 @@ module RailsBestPractices
 
       private
 
-        # check if the node is a finder call node.
-        def finder?(node)
-          node.receiver.const? && FINDERS.include?(node.message.to_s)
-        end
+      # check if the node is a finder call node.
+      def finder?(node)
+        node.receiver.const? && FINDERS.include?(node.message.to_s)
+      end
     end
   end
 end

data/lib/rails_best_practices/reviews/move_code_into_helper_review.rb

@@ -38,16 +38,15 @@ module RailsBestPractices
 
       private
 
-        # check if the arguments of options_for_select are complex.
-        #
-        # if the first argument is an array,
-        # and the size of array is greater than @array_count you defined,
-        # then it is complext.
-        def complex_select_options?(node)
-          'options_for_select' == node[1].message.to_s &&
-            :array == node.arguments.all.first.sexp_type &&
-            node.arguments.all.first.array_size > @array_count
-        end
+      # check if the arguments of options_for_select are complex.
+      #
+      # if the first argument is an array,
+      # and the size of array is greater than @array_count you defined,
+      # then it is complext.
+      def complex_select_options?(node)
+        node[1].message.to_s == 'options_for_select' && node.arguments.all.first.sexp_type == :array &&
+          node.arguments.all.first.array_size > @array_count
+      end
     end
   end
 end

data/lib/rails_best_practices/reviews/move_finder_to_named_scope_review.rb

@@ -29,17 +29,16 @@ module RailsBestPractices
 
       private
 
-        # check if the method_add_arg node is a finder.
-        #
-        # 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.
-        def finder?(node)
-          FINDERS.include?(node[1].message.to_s) &&
-            :call == node[1].sexp_type &&
-            node.arguments.grep_nodes_count(sexp_type: :bare_assoc_hash) > 0
-        end
+      # check if the method_add_arg node is a finder.
+      #
+      # 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.
+      def finder?(node)
+        FINDERS.include?(node[1].message.to_s) && node[1].sexp_type == :call &&
+          node.arguments.grep_nodes_count(sexp_type: :bare_assoc_hash) > 0
+      end
     end
   end
 end

data/lib/rails_best_practices/reviews/needless_deep_nesting_review.rb

@@ -51,30 +51,32 @@ module RailsBestPractices
 
       private
 
-        # check nested route.
-        #
-        # 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,
-        # 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)
-          shallow = @shallow_nodes.include? node
-          if %i[command_call command].include?(node[1].sexp_type) && %w[resources resource].include?(node[1].message.to_s)
-            hash_node = node[1].arguments.grep_node(sexp_type: :bare_assoc_hash)
-            shallow ||= (hash_node && 'true' == hash_node.hash_value('shallow').to_s)
-            @counter += 1
-            node.block_node.statements.each do |stmt_node|
-              @shallow_nodes << stmt_node if shallow
-              recursively_check(stmt_node)
-            end
-            @counter -= 1
-          elsif %i[command_call command].include?(node.sexp_type) && %w[resources resource].include?(node.message.to_s)
-            add_error "needless deep nesting (nested_count > #{@nested_count})", @file, node.line_number if @counter >= @nested_count && !@shallow_nodes.include?(node)
+      # check nested route.
+      #
+      # 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,
+      # 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)
+        shallow = @shallow_nodes.include? node
+
+        if %i[command_call command].include?(node[1].sexp_type) && %w[resources resource].include?(node[1].message.to_s)
+          hash_node = node[1].arguments.grep_node(sexp_type: :bare_assoc_hash)
+          shallow ||= (hash_node && hash_node.hash_value('shallow').to_s == 'true')
+          @counter += 1
+          node.block_node.statements.each do |stmt_node|
+            @shallow_nodes << stmt_node if shallow
+            recursively_check(stmt_node)
           end
+          @counter -= 1
+        elsif %i[command_call command].include?(node.sexp_type) && %w[resources resource].include?(node.message.to_s)
+          add_error "needless deep nesting (nested_count > #{@nested_count})", @file, node.line_number if @counter >=
+            @nested_count && !@shallow_nodes.include?(node)
         end
+      end
     end
   end
 end

data/lib/rails_best_practices/reviews/not_rescue_exception_review.rb

@@ -18,7 +18,7 @@ module RailsBestPractices
 
       # check rescue node to see if its type is Exception
       add_callback :start_rescue do |rescue_node|
-        if rescue_node.exception_classes.any? { |rescue_class| 'Exception' == rescue_class.to_s }
+        if rescue_node.exception_classes.any? { |rescue_class| rescue_class.to_s == 'Exception' }
           add_error "Don't rescue Exception", rescue_node.file, rescue_node.exception_classes.first.line_number
         end
       end

data/lib/rails_best_practices/reviews/not_use_default_route_review.rb

@@ -24,8 +24,7 @@ module RailsBestPractices
 
       # check all command nodes
       add_callback :start_command do |node|
-        if 'match' == node.message.to_s &&
-          ':controller(/:action(/:id(.:format)))' == node.arguments.all.first.to_s
+        if node.message.to_s == 'match' && node.arguments.all.first.to_s == ':controller(/:action(/:id(.:format)))'
           add_error 'not use default route'
         end
       end

data/lib/rails_best_practices/reviews/not_use_time_ago_in_words_review.rb

@@ -17,7 +17,7 @@ module RailsBestPractices
 
       # check fcall node to see if its message is time_ago_in_words or distance_of_time_in_words_to_now
       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
+        if node.message.to_s == 'time_ago_in_words' || node.message.to_s == 'distance_of_time_in_words_to_now'
           add_error 'not use time_ago_in_words'
         end
       end

data/lib/rails_best_practices/reviews/overuse_route_customizations_review.rb

@@ -41,14 +41,14 @@ module RailsBestPractices
 
       private
 
-        # check method_add_block node to calculate the count of member and collection custom routes.
-        #
-        # 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)
-          'resources' == node[1].message.to_s ? node.grep_nodes_count(sexp_type: :command, message: VERBS) : 0
-        end
+      # check method_add_block node to calculate the count of member and collection custom routes.
+      #
+      # 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)
+        node[1].message.to_s == 'resources' ? node.grep_nodes_count(sexp_type: :command, message: VERBS) : 0
+      end
     end
   end
 end

data/lib/rails_best_practices/reviews/protect_mass_assignment_review.rb

@@ -11,6 +11,7 @@ module RailsBestPractices
     # Review process:
     #   check nodes to see if there is a command with message attr_accessible or attr_protected,
     #   or include ActiveModel::ForbiddenAttributesProtection.
+
     class ProtectMassAssignmentReview < Review
       interesting_files MODEL_FILES
       interesting_nodes :class, :command, :var_ref, :vcall, :fcall
@@ -54,53 +55,55 @@ module RailsBestPractices
 
       private
 
-        def check_activerecord_version
-          if Prepares.gems.gem_version('activerecord').to_i > 3
-            @mass_assignement = false
-          end
+      def check_activerecord_version
+        if Prepares.gems.gem_version('activerecord').to_i > 3
+          @mass_assignement = false
         end
+      end
 
-        def check_whitelist_attributes_config
-          if 'true' == Prepares.configs['config.active_record.whitelist_attributes']
-            @whitelist_attributes = true
-          end
+      def check_whitelist_attributes_config
+        if Prepares.configs['config.active_record.whitelist_attributes'] == 'true'
+          @whitelist_attributes = true
         end
+      end
 
-        def check_include_forbidden_attributes_protection_config
-          if 'true' == Prepares.configs['railsbp.include_forbidden_attributes_protection']
-            @mass_assignement = false
-          end
+      def check_include_forbidden_attributes_protection_config
+        if Prepares.configs['railsbp.include_forbidden_attributes_protection'] == 'true'
+          @mass_assignement = false
         end
+      end
 
-        def check_rails_builtin(node)
-          if @whitelist_attributes || [node.to_s, node.message.to_s].any? { |str| %w[attr_accessible attr_protected].include? str }
-            @mass_assignement = false
-          end
+      def check_rails_builtin(node)
+        if @whitelist_attributes ||
+             [node.to_s, node.message.to_s].any? { |str| %w[attr_accessible attr_protected].include? str }
+          @mass_assignement = false
         end
+      end
 
-        def check_strong_parameters(command_node)
-          if 'include' == command_node.message.to_s && 'ActiveModel::ForbiddenAttributesProtection' == command_node.arguments.all.first.to_s
-            @mass_assignement = false
-          end
+      def check_strong_parameters(command_node)
+        if command_node.message.to_s == 'include' &&
+             command_node.arguments.all.first.to_s == 'ActiveModel::ForbiddenAttributesProtection'
+          @mass_assignement = false
         end
+      end
 
-        def check_devise(command_node)
-          if 'devise' == command_node.message.to_s
-            @mass_assignement = false
-          end
+      def check_devise(command_node)
+        if command_node.message.to_s == 'devise'
+          @mass_assignement = false
         end
+      end
 
-        def check_authlogic(node)
-          if [node.to_s, node.message.to_s].include? 'acts_as_authentic'
-            @mass_assignement = false
-          end
+      def check_authlogic(node)
+        if [node.to_s, node.message.to_s].include? 'acts_as_authentic'
+          @mass_assignement = false
         end
+      end
 
-        def check_active_record(const_path_ref_node)
-          if 'ActiveRecord::Base' != const_path_ref_node.base_class.to_s
-            @mass_assignement = false
-          end
+      def check_active_record(const_path_ref_node)
+        if const_path_ref_node.base_class.to_s != 'ActiveRecord::Base'
+          @mass_assignement = false
         end
+      end
     end
   end
 end

data/lib/rails_best_practices/reviews/remove_empty_helpers_review.rb

@@ -17,16 +17,16 @@ module RailsBestPractices
 
       # check the body of module node, if it is nil, then it should be removed.
       add_callback :start_module do |module_node|
-        if 'ApplicationHelper' != module_node.module_name.to_s && empty_body?(module_node)
+        if module_node.module_name.to_s != 'ApplicationHelper' && empty_body?(module_node)
           add_error 'remove empty helpers'
         end
       end
 
       protected
 
-        def empty_body?(module_node)
-          s(:bodystmt, s(:stmts_add, s(:stmts_new), s(:void_stmt)), nil, nil, nil) == module_node.body
-        end
+      def empty_body?(module_node)
+        s(:bodystmt, s(:stmts_add, s(:stmts_new), s(:void_stmt)), nil, nil, nil) == module_node.body
+      end
     end
   end
 end

data/lib/rails_best_practices/reviews/remove_unused_methods_in_controllers_review.rb

@@ -11,6 +11,7 @@ module RailsBestPractices
     #   if they are not defined in routes,
     #   and they are not called in controllers,
     #   then they are the unused methods in controllers.
+
     class RemoveUnusedMethodsInControllersReview < Review
       include Classable
       include Moduleable
@@ -30,11 +31,15 @@ module RailsBestPractices
         @inherited_resources = false
       end
 
+      add_callback :start_class do |_node|
+        @current_controller_name = @klass.to_s
+      end
+
       # mark custom inherited_resources methods as used.
       add_callback :end_class do |_node|
         if @inherited_resources
           INHERITED_RESOURCES_METHODS.each do |method|
-            call_method(method)
+            call_method(method, @current_controller_name)
           end
         end
       end
@@ -56,7 +61,7 @@ module RailsBestPractices
             action_name = first_argument.hash_value('state').to_s
             call_method(action_name, current_class_name)
           end
-        when 'around_filter'
+        when 'around_filter', 'around_action'
           node.arguments.all.each { |argument| mark_used(argument) }
         when 'layout'
           first_argument = node.arguments.all.first
@@ -67,7 +72,7 @@ module RailsBestPractices
           node.arguments.all.each { |argument| mark_publicize(argument.to_s) }
         when 'delegate'
           last_argument = node.arguments.all.last
-          if :bare_assoc_hash == last_argument.sexp_type && 'controller' == last_argument.hash_value('to').to_s
+          if last_argument.sexp_type == :bare_assoc_hash && last_argument.hash_value('to').to_s == 'controller'
             controller_name = current_module_name.sub('Helper', 'Controller')
             node.arguments.all[0..-2].each { |method| mark_publicize(method.to_s, controller_name) }
           end
@@ -78,7 +83,7 @@ module RailsBestPractices
 
       # mark assignment as used, like current_user = @user
       add_callback :start_assign do |node|
-        if :var_field == node.left_value.sexp_type
+        if node.left_value.sexp_type == :var_field
           call_method "#{node.left_value}=", current_class_name
         end
       end
@@ -86,7 +91,7 @@ module RailsBestPractices
       # get all unused methods at the end of review process.
       add_callback :after_check do
         @routes.each do |route|
-          if '*' == route.action_name
+          if route.action_name == '*'
             action_names = @controller_methods.get_methods(route.controller_name_with_namespaces).map(&:method_name)
             action_names.each { |action_name| call_method(action_name, route.controller_name_with_namespaces) }
           else
@@ -94,27 +99,29 @@ module RailsBestPractices
           end
         end
         @controller_methods.get_all_unused_methods.each do |method|
-          unless excepted?(method)
-            add_error "remove unused methods (#{method.class_name}##{method.method_name})", method.file, method.line_number
-          end
+          next if excepted?(method)
+
+          add_error "remove unused methods (#{method.class_name}##{method.method_name})",
+                    method.file,
+                    method.line_number
         end
       end
 
       protected
 
-        def methods
-          @controller_methods
-        end
+      def methods
+        @controller_methods
+      end
 
-        def internal_except_methods
-          %w[rescue_action default_url_options].map { |method_name| "*\##{method_name}" } +
-            %w[Devise::OmniauthCallbacksController].map { |controller_name| "#{controller_name}#*" }
-        end
+      def internal_except_methods
+        %w[rescue_action default_url_options].map { |method_name| "*\##{method_name}" } +
+          %w[Devise::OmniauthCallbacksController].map { |controller_name| "#{controller_name}#*" }
+      end
 
-        def mark_publicize(method_name, class_name = current_class_name)
-          @controller_methods.mark_publicize(class_name, method_name)
-          @controller_methods.mark_parent_class_methods_publicize(class_name, method_name)
-        end
+      def mark_publicize(method_name, class_name = current_class_name)
+        @controller_methods.mark_publicize(class_name, method_name)
+        @controller_methods.mark_parent_class_methods_publicize(class_name, method_name)
+      end
     end
   end
 end