rails_best_practices 1.19.0 → 1.19.1

data/lib/rails_best_practices/reviews/remove_empty_helpers_review.rb

@@ -12,12 +12,12 @@ module RailsBestPractices
     class RemoveEmptyHelpersReview < Review
       interesting_nodes :module
       interesting_files HELPER_FILES
-      url "https://rails-bestpractices.com/posts/2011/04/09/remove-empty-helpers/"
+      url 'https://rails-bestpractices.com/posts/2011/04/09/remove-empty-helpers/'
 
       # 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)
-          add_error "remove empty helpers"
+        if 'ApplicationHelper' != module_node.module_name.to_s && empty_body?(module_node)
+          add_error 'remove empty helpers'
         end
       end
 

data/lib/rails_best_practices/reviews/remove_unused_methods_in_controllers_review.rb

@@ -46,28 +46,28 @@ module RailsBestPractices
       # mark corresponding action as used for cells' render and render_call.
       add_callback :start_command, :start_method_add_arg do |node|
         case node.message.to_s
-        when "render_cell"
+        when 'render_cell'
           controller_name, action_name, _ = *node.arguments.all.map(&:to_s)
           call_method(action_name, "#{controller_name}_cell".classify)
-        when "render"
+        when 'render'
           first_argument = node.arguments.all.first
-          if first_argument.present? && first_argument.hash_value("state").present?
-            action_name = first_argument.hash_value("state").to_s
+          if first_argument.present? && first_argument.hash_value('state').present?
+            action_name = first_argument.hash_value('state').to_s
             call_method(action_name, current_class_name)
           end
-        when "around_filter"
+        when 'around_filter'
           node.arguments.all.each { |argument| mark_used(argument) }
-        when "layout"
+        when 'layout'
           first_argument = node.arguments.all.first
           if first_argument.sexp_type == :symbol_literal
             mark_used(first_argument)
           end
-        when "helper_method"
+        when 'helper_method'
           node.arguments.all.each { |argument| mark_publicize(argument.to_s) }
-        when "delegate"
+        when 'delegate'
           last_argument = node.arguments.all.last
-          if :bare_assoc_hash == last_argument.sexp_type && "controller" == last_argument.hash_value("to").to_s
-            controller_name = current_module_name.sub("Helper", "Controller")
+          if :bare_assoc_hash == last_argument.sexp_type && 'controller' == last_argument.hash_value('to').to_s
+            controller_name = current_module_name.sub('Helper', 'Controller')
             node.arguments.all[0..-2].each { |method| mark_publicize(method.to_s, controller_name) }
           end
         else
@@ -85,7 +85,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

data/lib/rails_best_practices/reviews/remove_unused_methods_in_helpers_review.rb

@@ -38,7 +38,7 @@ module RailsBestPractices
         end
 
         def internal_except_methods
-          ["*#url_for"]
+          ['*#url_for']
         end
     end
   end

data/lib/rails_best_practices/reviews/remove_unused_methods_in_models_review.rb

@@ -32,12 +32,12 @@ module RailsBestPractices
       add_callback :start_command do |node|
         arguments = node.arguments.all
         case node.message.to_s
-        when "validate", "validate_on_create", "validate_on_update"
+        when 'validate', 'validate_on_create', 'validate_on_update'
           arguments.each { |argument| mark_used(argument) }
-        when "collection_select"
+        when 'collection_select'
           mark_used(arguments[3])
           mark_used(arguments[4])
-        when "grouped_collection_select"
+        when 'grouped_collection_select'
           mark_used(arguments[3])
           mark_used(arguments[4])
           mark_used(arguments[5])
@@ -49,10 +49,10 @@ module RailsBestPractices
       add_callback :start_command_call do |node|
         arguments = node.arguments.all
         case node.message.to_s
-        when "collection_select"
+        when 'collection_select'
           mark_used(arguments[2])
           mark_used(arguments[3])
-        when "grouped_collection_select"
+        when 'grouped_collection_select'
           mark_used(arguments[2])
           mark_used(arguments[3])
           mark_used(arguments[4])
@@ -65,10 +65,10 @@ module RailsBestPractices
       add_callback :start_method_add_arg do |node|
         arguments = node.arguments.all
         case node.message.to_s
-        when "options_from_collection_for_select"
+        when 'options_from_collection_for_select'
           mark_used(arguments[1])
           mark_used(arguments[2])
-        when "option_groups_from_collection_for_select"
+        when 'option_groups_from_collection_for_select'
           mark_used(arguments[1])
           mark_used(arguments[2])
           mark_used(arguments[3])
@@ -100,6 +100,7 @@ module RailsBestPractices
             before_save before_create before_update before_destroy after_save after_create
             after_update after_destroy after_find after_initialize
             method_missing
+            table_name module_prefix
           ).map { |method_name| "*\##{method_name}" }
         end
     end

data/lib/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review.rb

@@ -17,7 +17,7 @@ module RailsBestPractices
     class ReplaceComplexCreationWithFactoryMethodReview < Review
       interesting_nodes :def
       interesting_files CONTROLLER_FILES
-      url "https://rails-bestpractices.com/posts/2010/07/21/replace-complex-creation-with-factory-method/"
+      url 'https://rails-bestpractices.com/posts/2010/07/21/replace-complex-creation-with-factory-method/'
 
       def initialize(options = {})
         super(options)
@@ -53,7 +53,7 @@ module RailsBestPractices
         # 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
+          if ['save', 'save!'].include? node.message.to_s
             variable = node.receiver.to_s
             if variable_use_count[variable].to_i > @assigns_count
               hint = "#{variable} attribute_assignment_count > #{@assigns_count}"

data/lib/rails_best_practices/reviews/replace_instance_variable_with_local_variable_review.rb

@@ -13,13 +13,13 @@ module RailsBestPractices
     class ReplaceInstanceVariableWithLocalVariableReview < Review
       interesting_nodes :var_ref, :vcall
       interesting_files PARTIAL_VIEW_FILES
-      url "https://rails-bestpractices.com/posts/2010/07/24/replace-instance-variable-with-local-variable/"
+      url 'https://rails-bestpractices.com/posts/2010/07/24/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.
       add_callback :start_var_ref, :start_vcall do |node|
         if node.to_s.start_with?('@')
-          add_error "replace instance variable with local variable"
+          add_error 'replace instance variable with local variable'
         end
       end
     end

data/lib/rails_best_practices/reviews/restrict_auto_generated_routes_review.rb

@@ -15,7 +15,7 @@ module RailsBestPractices
     class RestrictAutoGeneratedRoutesReview < Review
       interesting_nodes :command, :command_call, :method_add_block
       interesting_files ROUTE_FILES
-      url "https://rails-bestpractices.com/posts/2011/08/19/restrict-auto-generated-routes/"
+      url 'https://rails-bestpractices.com/posts/2011/08/19/restrict-auto-generated-routes/'
 
       def resource_methods
         if Prepares.configs['config.api_only']
@@ -37,23 +37,23 @@ module RailsBestPractices
 
       # 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
+        if 'resources' == node.message.to_s
           if (mod = module_option(node))
             @namespaces << mod
           end
           check_resources(node)
           @resource_controllers << node.arguments.all.first.to_s
-        elsif "resource" == node.message.to_s
+        elsif 'resource' == node.message.to_s
           check_resource(node)
           @resource_controllers << node.arguments.all.first.to_s
         end
       end
 
       add_callback :end_command do |node|
-        if "resources" == node.message.to_s
+        if 'resources' == node.message.to_s
           @resource_controllers.pop
           @namespaces.pop if module_option(node)
-        elsif "resource" == node.message.to_s
+        elsif 'resource' == node.message.to_s
           @resource_controllers.pop
         end
       end
@@ -61,9 +61,9 @@ module RailsBestPractices
       # remember the namespace.
       add_callback :start_method_add_block do |node|
         case node.message.to_s
-        when "namespace"
+        when 'namespace'
           @namespaces << node.arguments.all.first.to_s if check_method_add_block?(node)
-        when "resources", "resource"
+        when 'resources', 'resource'
           @resource_controllers << node.arguments.all.first.to_s if check_method_add_block?(node)
         when 'scope'
           if check_method_add_block?(node) && (mod = module_option(node))
@@ -77,9 +77,9 @@ module RailsBestPractices
       add_callback :end_method_add_block do |node|
         if check_method_add_block?(node)
           case node.message.to_s
-          when "namespace"
+          when 'namespace'
             @namespaces.pop
-          when "resources", "resource"
+          when 'resources', 'resource'
             @resource_controllers.pop
           when 'scope'
             if check_method_add_block?(node) && module_option(node)
@@ -90,7 +90,7 @@ module RailsBestPractices
       end
 
       def check_method_add_block?(node)
-        :command == node[1].sexp_type || (:command_call == node[1].sexp_type && "map" != node.receiver.to_s)
+        :command == node[1].sexp_type || (:command_call == node[1].sexp_type && 'map' != node.receiver.to_s)
       end
 
       private
@@ -109,13 +109,13 @@ module RailsBestPractices
         def controller_name(node)
           if option_with_hash(node)
             option_node = node.arguments.all[1]
-            if hash_key_exist?(option_node,"controller")
-              name = option_node.hash_value("controller").to_s
+            if hash_key_exist?(option_node,'controller')
+              name = option_node.hash_value('controller').to_s
             else
-              name = node.arguments.all.first.to_s.gsub("::", "").tableize
+              name = node.arguments.all.first.to_s.gsub('::', '').tableize
             end
           else
-            name = node.arguments.all.first.to_s.gsub("::", "").tableize
+            name = node.arguments.all.first.to_s.gsub('::', '').tableize
           end
           namespaced_class_name(name)
         end
@@ -126,7 +126,7 @@ module RailsBestPractices
           if @namespaces.empty?
             class_name
           else
-            @namespaces.map { |namespace| "#{namespace.camelize}::" }.join("") + class_name
+            @namespaces.map { |namespace| "#{namespace.camelize}::" }.join('') + class_name
           end
         end
 
@@ -149,13 +149,13 @@ module RailsBestPractices
         def _methods(node, methods)
           if option_with_hash(node)
             option_node = node.arguments.all[1]
-            if hash_key_exist?(option_node, "only")
-              option_node.hash_value("only").to_s == "none" ? [] : Array(option_node.hash_value("only").to_object)
-            elsif hash_key_exist?(option_node, "except")
-              if option_node.hash_value("except").to_s == "all"
+            if hash_key_exist?(option_node, 'only')
+              option_node.hash_value('only').to_s == 'none' ? [] : Array(option_node.hash_value('only').to_object)
+            elsif hash_key_exist?(option_node, 'except')
+              if option_node.hash_value('except').to_s == 'all'
                 []
               else
-                (methods - Array(option_node.hash_value("except").to_object))
+                (methods - Array(option_node.hash_value('except').to_object))
               end
             else
               methods
@@ -182,9 +182,9 @@ module RailsBestPractices
 
         def friendly_route_name(node)
           if @resource_controllers.last == node.arguments.to_s
-            [@namespaces.join("/"), @resource_controllers.join("/")].delete_if(&:blank?).join("/")
+            [@namespaces.join('/'), @resource_controllers.join('/')].delete_if(&:blank?).join('/')
           else
-            [@namespaces.join("/"), @resource_controllers.join("/"), node.arguments.to_s].delete_if(&:blank?).join("/")
+            [@namespaces.join('/'), @resource_controllers.join('/'), node.arguments.to_s].delete_if(&:blank?).join('/')
           end
         end
     end

data/lib/rails_best_practices/reviews/review.rb

@@ -4,7 +4,7 @@ module RailsBestPractices
     # A Review class that takes charge of reviewing one rails best practice.
     class Review < Core::Check
       # default url.
-      url "#"
+      url '#'
 
       # remember use count for the variable in the call or assign node.
       #
@@ -12,7 +12,7 @@ module RailsBestPractices
       # 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 && "self" != variable_node.to_s && @last_variable_node != variable_node
+        if variable_node && 'self' != variable_node.to_s && @last_variable_node != variable_node
           @last_variable_node = variable_node
           variable_use_count[variable_node.to_s] ||= 0
           variable_use_count[variable_node.to_s] += 1

data/lib/rails_best_practices/reviews/simplify_render_in_controllers_review.rb

@@ -14,16 +14,16 @@ module RailsBestPractices
     class SimplifyRenderInControllersReview < Review
       interesting_nodes :command
       interesting_files CONTROLLER_FILES
-      url "https://rails-bestpractices.com/posts/2010/12/12/simplify-render-in-controllers/"
+      url 'https://rails-bestpractices.com/posts/2010/12/12/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.
       add_callback :start_command do |node|
-        if "render" == node.message.to_s
+        if 'render' == node.message.to_s
           keys = node.arguments.all.first.hash_keys
           if keys && keys.size == 1 &&
-             (keys.include?("action") || keys.include?("template") || keys.include?("file"))
+             (keys.include?('action') || keys.include?('template') || keys.include?('file'))
             add_error 'simplify render in controllers'
           end
         end

data/lib/rails_best_practices/reviews/simplify_render_in_views_review.rb

@@ -13,7 +13,7 @@ module RailsBestPractices
     class SimplifyRenderInViewsReview < Review
       interesting_nodes :command
       interesting_files VIEW_FILES
-      url "https://rails-bestpractices.com/posts/2010/12/04/simplify-render-in-views/"
+      url 'https://rails-bestpractices.com/posts/2010/12/04/simplify-render-in-views/'
 
       VALID_KEYS = %w(object collection locals)
 
@@ -21,7 +21,7 @@ module RailsBestPractices
       # if its message is render and the arguments contain a key partial,
       # then it should be replaced by simplified syntax.
       add_callback :start_command do |node|
-        if "render" == node.message.to_s
+        if 'render' == node.message.to_s
           hash_node =  node.arguments.all.first
           if hash_node && :bare_assoc_hash == hash_node.sexp_type &&
               include_partial?(hash_node) && valid_hash?(hash_node)
@@ -33,12 +33,12 @@ module RailsBestPractices
       protected
 
         def include_partial?(hash_node)
-          hash_node.hash_keys.include?("partial") && !hash_node.hash_value("partial").to_s.include?('/')
+          hash_node.hash_keys.include?('partial') && !hash_node.hash_value('partial').to_s.include?('/')
         end
 
         def valid_hash?(hash_node)
           keys = hash_node.hash_keys
-          keys.delete("partial")
+          keys.delete('partial')
           (keys - VALID_KEYS).empty?
         end
     end

data/lib/rails_best_practices/reviews/use_before_filter_review.rb

@@ -14,7 +14,7 @@ module RailsBestPractices
     class UseBeforeFilterReview < Review
       interesting_nodes :class
       interesting_files CONTROLLER_FILES
-      url "https://rails-bestpractices.com/posts/2010/07/24/use-before_filter/"
+      url 'https://rails-bestpractices.com/posts/2010/07/24/use-before_filter/'
 
       def initialize(options = {})
         super()
@@ -31,7 +31,7 @@ module RailsBestPractices
 
         node.body.statements.each do |statement_node|
           var_ref_or_vcall_included = [:var_ref, :vcall].include?(statement_node.sexp_type)
-          private_or_protected_included = ["protected", "private"].include?(statement_node.to_s)
+          private_or_protected_included = ['protected', 'private'].include?(statement_node.to_s)
           break if var_ref_or_vcall_included && private_or_protected_included
           remember_first_sentence(statement_node) if :def == statement_node.sexp_type
         end

data/lib/rails_best_practices/reviews/use_model_association_review.rb

@@ -16,7 +16,7 @@ module RailsBestPractices
     class UseModelAssociationReview < Review
       interesting_nodes :def
       interesting_files CONTROLLER_FILES
-      url "https://rails-bestpractices.com/posts/2010/07/19/use-model-association/"
+      url 'https://rails-bestpractices.com/posts/2010/07/19/use-model-association/'
 
       # check method define nodes to see if there are some attribute assignments that can use model association instead.
       #
@@ -56,7 +56,7 @@ module RailsBestPractices
         # 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
+          if ['save', 'save!'].include? node.message.to_s
             receiver = node.receiver.to_s
             add_error "use model association (for #{receiver})" if @assignments[receiver]
           end

data/lib/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review.rb

@@ -13,7 +13,7 @@ module RailsBestPractices
     class UseMultipartAlternativeAsContentTypeOfEmailReview < Review
       interesting_nodes :class, :def
       interesting_files MAILER_FILES
-      url "https://rails-bestpractices.com/posts/2010/08/05/use-multipart-alternative-as-content_type-of-email/"
+      url 'https://rails-bestpractices.com/posts/2010/08/05/use-multipart-alternative-as-content_type-of-email/'
 
       # check class node to remember the ActionMailer class name.
       add_callback :start_class do |node|
@@ -24,7 +24,7 @@ module RailsBestPractices
       add_callback :start_def do |node|
         name = node.method_name.to_s
         if !rails3_canonical_mailer_views?(name)
-          add_error("use multipart/alternative as content_type of email")
+          add_error('use multipart/alternative as content_type of email')
         end
       end
 

data/lib/rails_best_practices/reviews/use_observer_review.rb

@@ -20,7 +20,7 @@ module RailsBestPractices
     class UseObserverReview < Review
       interesting_nodes :def, :command
       interesting_files MODEL_FILES
-      url "https://rails-bestpractices.com/posts/2010/07/24/use-observer/"
+      url 'https://rails-bestpractices.com/posts/2010/07/24/use-observer/'
 
       def initialize(options = {})
         super
@@ -42,7 +42,7 @@ module RailsBestPractices
       # then it should be replaced by using observer.
       add_callback :start_def do |node|
         if callback_method?(node) && deliver_mailer?(node)
-          add_error "use observer"
+          add_error 'use observer'
         end
       end
 
@@ -71,7 +71,7 @@ module RailsBestPractices
         # then the call node is actionmailer deliver call.
         def deliver_mailer?(node)
           node.grep_nodes(sexp_type: :call) do |child_node|
-            if "deliver" == child_node.message.to_s
+            if 'deliver' == child_node.message.to_s
               if :method_add_arg == child_node.receiver.sexp_type &&
                 mailers.include?(child_node.receiver[1].receiver.to_s)
                 return true

data/lib/rails_best_practices/reviews/use_parentheses_in_method_def_review.rb

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

data/lib/rails_best_practices/reviews/use_query_attribute_review.rb

@@ -16,7 +16,7 @@ module RailsBestPractices
     class UseQueryAttributeReview < Review
       interesting_nodes :if, :unless, :elsif, :ifop, :if_mod, :unless_mod
       interesting_files ALL_FILES
-      url "https://rails-bestpractices.com/posts/2010/10/03/use-query-attribute/"
+      url 'https://rails-bestpractices.com/posts/2010/10/03/use-query-attribute/'
 
       QUERY_METHODS = %w(nil? blank? present?)
 
@@ -102,13 +102,13 @@ module RailsBestPractices
         def model_attribute?(variable_node, message)
           class_name = variable_node.to_s.sub(/^@/, '').classify
           attribute_type = model_attributes.get_attribute_type(class_name, message)
-          attribute_type && !["integer", "float"].include?(attribute_type)
+          attribute_type && !['integer', 'float'].include?(attribute_type)
         end
 
         # check if the node is with node type :binary, node message :== and node argument is empty string.
         def compare_with_empty_string?(node)
           :binary == node.sexp_type &&
-            ["==", "!="].include?(node.message.to_s) &&
+            ['==', '!='].include?(node.message.to_s) &&
             s(:string_literal, s(:string_content)) == node.argument
         end
     end