rails_best_practices 1.20.0 → 1.20.1

data/lib/rails_best_practices/reviews/hash_syntax_review.rb

@@ -12,7 +12,7 @@ module RailsBestPractices
       interesting_nodes :hash, :bare_assoc_hash
       interesting_files ALL_FILES
 
-      VALID_SYMBOL_KEY = /\A[@$_A-Za-z]([_\w]*[!_=?\w])?\z/
+      VALID_SYMBOL_KEY = /\A[@$_A-Za-z]([_\w]*[!_=?\w])?\z/.freeze
 
       # check hash node to see if it is ruby 1.8 style.
       add_callback :start_hash, :start_bare_assoc_hash do |node|
@@ -23,12 +23,12 @@ module RailsBestPractices
 
       protected
 
-        # check if hash node is empty.
+      # check if hash node is empty.
       def empty_hash?(node)
         s(:hash, nil) == node || s(:bare_assoc_hash, nil) == node
       end
 
-        # check if hash key/value pairs are ruby 1.8 style.
+      # check if hash key/value pairs are ruby 1.8 style.
       def hash_is_18?(node)
         pair_nodes = node.sexp_type == :hash ? node[1][1] : node[1]
         return false if pair_nodes.blank?
@@ -36,8 +36,8 @@ module RailsBestPractices
         pair_nodes.any? { |pair_node| pair_node[1].sexp_type == :symbol_literal }
       end
 
-        # check if the hash keys are valid to be converted to ruby 1.9
-        # syntax.
+      # check if the hash keys are valid to be converted to ruby 1.9
+      # syntax.
       def valid_keys?(node)
         node.hash_keys.all? { |key| key =~ VALID_SYMBOL_KEY }
       end

data/lib/rails_best_practices/reviews/isolate_seed_data_review.rb

@@ -55,9 +55,9 @@ module RailsBestPractices
 
       private
 
-        # check assignment node,
-        # if the right vavlue is a method_add_arg node with message "new",
-        # then remember the left value as new variable.
+      # check assignment node,
+      # if the right vavlue is a method_add_arg node with message "new",
+      # then remember the left value as new variable.
       def remember_new_variable(node)
         right_value = node.right_value
         if right_value.sexp_type == :method_add_arg && right_value.message.to_s == 'new'
@@ -65,7 +65,7 @@ module RailsBestPractices
         end
       end
 
-        # see if the receiver of the call node is included in the @new_varaibles.
+      # see if the receiver of the call node is included in the @new_varaibles.
       def new_record?(node)
         @new_variables.include? node.receiver.to_s
       end

data/lib/rails_best_practices/reviews/keep_finders_on_their_own_model_review.rb

@@ -37,15 +37,14 @@ module RailsBestPractices
 
       private
 
-        # check if the call node is the finder of other model.
-        #
-        # the message of the node should be one of find, all, first or last,
-        # and the receiver of the node should be with message :call (this is the other model),
-        # and any of its arguments is a hash,
-        # then it is the finder of other model.
+      # check if the call node is the finder of other model.
+      #
+      # the message of the node should be one of find, all, first or last,
+      # and the receiver of the node should be with message :call (this is the other model),
+      # and any of its arguments is a hash,
+      # then it is the finder of other model.
       def other_finder?(node)
-        FINDERS.include?(node[1].message.to_s) &&
-          node[1].receiver.sexp_type == :call &&
+        FINDERS.include?(node[1].message.to_s) && node[1].receiver.sexp_type == :call &&
           node.arguments.grep_nodes_count(sexp_type: :bare_assoc_hash) > 0
       end
     end

data/lib/rails_best_practices/reviews/law_of_demeter_review.rb

@@ -35,11 +35,11 @@ module RailsBestPractices
 
       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.
+      # 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)
 
@@ -55,7 +55,7 @@ module RailsBestPractices
         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'))
+                 model_associations.is_association?(class_name, association_name.sub(/able$/, 's'))
               return true if model_attributes.is_attribute?(class_name, attribute_name)
             end
           end

data/lib/rails_best_practices/reviews/move_code_into_controller_review.rb

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

data/lib/rails_best_practices/reviews/move_code_into_helper_review.rb

@@ -38,14 +38,13 @@ 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.
+      # 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[1].message.to_s == 'options_for_select' && node.arguments.all.first.sexp_type == :array &&
           node.arguments.all.first.array_size > @array_count
       end
     end

data/lib/rails_best_practices/reviews/move_finder_to_named_scope_review.rb

@@ -29,15 +29,14 @@ 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.
+      # 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 &&
+        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

data/lib/rails_best_practices/reviews/needless_deep_nesting_review.rb

@@ -51,17 +51,18 @@ 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.
+      # 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')
@@ -72,7 +73,8 @@ module RailsBestPractices
           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)
+          add_error "needless deep nesting (nested_count > #{@nested_count})", @file, node.line_number if @counter >=
+            @nested_count && !@shallow_nodes.include?(node)
         end
       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 node.message.to_s == 'match' &&
-           node.arguments.all.first.to_s == ':controller(/:action(/:id(.:format)))'
+        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/overuse_route_customizations_review.rb

@@ -41,11 +41,11 @@ 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.
+      # 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

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
@@ -73,13 +74,15 @@ module RailsBestPractices
       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 }
+        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 command_node.message.to_s == 'include' && command_node.arguments.all.first.to_s == 'ActiveModel::ForbiddenAttributesProtection'
+        if command_node.message.to_s == 'include' &&
+             command_node.arguments.all.first.to_s == 'ActiveModel::ForbiddenAttributesProtection'
           @mass_assignement = false
         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
@@ -98,9 +99,11 @@ 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
 

data/lib/rails_best_practices/reviews/remove_unused_methods_in_helpers_review.rb

@@ -20,15 +20,17 @@ module RailsBestPractices
       def initialize(options = {})
         super
         @helper_methods = Prepares.helper_methods
-        self.class.interesting_files Prepares.helpers.map(&:descendants)
+        self.class.interesting_files *Prepares.helpers.map(&:descendants)
       end
 
       # get all unused methods at the end of review process
       add_callback :after_check do
         @helper_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
 

data/lib/rails_best_practices/reviews/remove_unused_methods_in_models_review.rb

@@ -80,9 +80,11 @@ module RailsBestPractices
       # get all unused methods at the end of review process.
       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_number
-          end
+          next unless !excepted?(method) && method.method_name !~ /=$/
+
+          add_error "remove unused methods (#{method.class_name}##{method.method_name})",
+                    method.file,
+                    method.line_number
         end
       end
 
@@ -95,13 +97,31 @@ module RailsBestPractices
       def internal_except_methods
         %w[
           initialize
-          validate validate_each validate_on_create validate_on_update
-          human_attribute_name assign_attributes attributes attribute
-          to_xml to_json as_json to_param
-          before_save before_create before_update before_destroy after_save after_create
-          after_update after_destroy after_find after_initialize
+          validate
+          validate_each
+          validate_on_create
+          validate_on_update
+          human_attribute_name
+          assign_attributes
+          attributes
+          attribute
+          to_xml
+          to_json
+          as_json
+          to_param
+          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
+          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

@@ -49,9 +49,9 @@ module RailsBestPractices
 
       private
 
-        # check the call node to see if it is with message "save" or "save!",
-        # 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.
+      # check the call node to see if it is with message "save" or "save!",
+      # 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.receiver.to_s

data/lib/rails_best_practices/reviews/restrict_auto_generated_routes_review.rb

@@ -95,32 +95,33 @@ module RailsBestPractices
 
       private
 
-        # check resources call, if the routes generated by resources does not exist in the controller.
+      # check resources call, if the routes generated by resources does not exist in the controller.
       def check_resources(node)
         _check(node, resources_methods)
       end
 
-        # check resource call, if the routes generated by resources does not exist in the controller.
+      # check resource call, if the routes generated by resources does not exist in the controller.
       def check_resource(node)
         _check(node, resource_methods)
       end
 
-        # get the controller name.
+      # get the controller name.
       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
-          else
-            name = node.arguments.all.first.to_s.gsub('::', '').tableize
-          end
+          name =
+            if hash_key_exist?(option_node, 'controller')
+              option_node.hash_value('controller').to_s
+            else
+              node.arguments.all.first.to_s.gsub('::', '').tableize
+            end
         else
           name = node.arguments.all.first.to_s.gsub('::', '').tableize
         end
         namespaced_class_name(name)
       end
 
-        # get the class name with namespace.
+      # get the class name with namespace.
       def namespaced_class_name(name)
         class_name = "#{name.split('/').map(&:camelize).join('::')}Controller"
         if @namespaces.empty?
@@ -138,11 +139,12 @@ module RailsBestPractices
         unless _methods.all? { |meth| Prepares.controller_methods.has_method?(controller_name, meth) }
           prepared_method_names = Prepares.controller_methods.get_methods(controller_name).map(&:method_name)
           only_methods = (_methods & prepared_method_names).map { |meth| ":#{meth}" }
-          routes_message = if only_methods.size > 3
-                             "except: [#{(methods.map { |meth| ':' + meth } - only_methods).join(', ')}]"
-                           else
-                             "only: [#{only_methods.join(', ')}]"
-                           end
+          routes_message =
+            if only_methods.size > 3
+              "except: [#{(methods.map { |meth| ':' + meth } - only_methods).join(', ')}]"
+            else
+              "only: [#{only_methods.join(', ')}]"
+            end
           add_error "restrict auto-generated routes #{friendly_route_name(node)} (#{routes_message})"
         end
       end
@@ -178,7 +180,7 @@ module RailsBestPractices
       end
 
       def hash_key_exist?(node, key)
-        node.hash_keys && node.hash_keys.include?(key)
+        node.hash_keys&.include?(key)
       end
 
       def friendly_route_name(node)

data/lib/rails_best_practices/reviews/simplify_render_in_controllers_review.rb

@@ -23,8 +23,7 @@ module RailsBestPractices
       add_callback :start_command do |node|
         if node.message.to_s == 'render'
           keys = node.arguments.all.first.hash_keys
-          if keys && keys.size == 1 &&
-             (keys.include?('action') || keys.include?('template') || keys.include?('file'))
+          if keys && keys.size == 1 && (keys.include?('action') || keys.include?('template') || keys.include?('file'))
             add_error 'simplify render in controllers'
           end
         end