# frozen_string_literal: true module RuboCop module Cop module Performance # Identifies places where string identifier argument can be replaced # by symbol identifier argument. # It prevents the redundancy of the internal string-to-symbol conversion. # # This cop targets methods that take identifier (e.g. method name) argument # and the following examples are parts of it. # # @example # # # bad # send('do_something') # attr_accessor 'do_something' # instance_variable_get('@ivar') # const_get("string_#{interpolation}") # # # good # send(:do_something) # attr_accessor :do_something # instance_variable_get(:@ivar) # const_get(:"string_#{interpolation}") # class StringIdentifierArgument < Base extend AutoCorrector MSG = 'Use `%s` instead of `%s`.' COMMAND_METHODS = %i[ alias_method attr_accessor attr_reader attr_writer autoload autoload? private private_constant protected public public_constant module_function ].freeze TWO_ARGUMENTS_METHOD = :alias_method MULTIPLE_ARGUMENTS_METHODS = %i[ attr_accessor attr_reader attr_writer private private_constant protected public public_constant module_function ].freeze # NOTE: `attr` method is not included in this list as it can cause false positives in Nokogiri API. # And `attr` may not be used because `Style/Attr` registers an offense. # https://github.com/rubocop/rubocop-performance/issues/278 RESTRICT_ON_SEND = (%i[ class_variable_defined? const_defined? const_get const_set const_source_location define_method instance_method method_defined? private_class_method? private_method_defined? protected_method_defined? public_class_method public_instance_method public_method_defined? remove_class_variable remove_method undef_method class_variable_get class_variable_set deprecate_constant remove_const ruby2_keywords define_singleton_method instance_variable_defined? instance_variable_get instance_variable_set method public_method public_send remove_instance_variable respond_to? send singleton_method __send__ ] + COMMAND_METHODS).freeze def on_send(node) return if COMMAND_METHODS.include?(node.method_name) && node.receiver string_arguments(node).each do |string_argument| string_argument_value = string_argument.value next if string_argument_value.include?(' ') || string_argument_value.include?('::') register_offense(string_argument, string_argument_value) end end private def string_arguments(node) arguments = if node.method?(TWO_ARGUMENTS_METHOD) [node.first_argument, node.arguments[1]] elsif MULTIPLE_ARGUMENTS_METHODS.include?(node.method_name) node.arguments else [node.first_argument] end arguments.compact.filter do |argument| argument.str_type? || argument.dstr_type? end end def register_offense(argument, argument_value) replacement = argument_replacement(argument, argument_value) message = format(MSG, symbol_arg: replacement, string_arg: argument.source) add_offense(argument, message: message) do |corrector| corrector.replace(argument, replacement) end end def argument_replacement(node, value) if node.str_type? value.to_sym.inspect else ":\"#{value.to_sym}\"" end end end end end end