Class: RuboCop::Cop::InternalAffairs::RedundantMessageArgument

Inherits:
Cop
  • Object
show all
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/internal_affairs/redundant_message_argument.rb

Overview

Checks for redundant message arguments to ‘#add_offense`. This method will automatically use `#message` or `MSG` (in that order of priority) if they are defined.

Examples:


# bad
add_offense(node, message: MSG)
add_offense(node, message: message)
add_offense(node, message: message(node))

# good
add_offense(node)
add_offense(node, message: CUSTOM_MSG)
add_offense(node, message: message(other_node))

Constant Summary collapse

MSG = 
'Redundant message argument to `#add_offense`.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from RuboCop::Cop::IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#autocorrect(node) ⇒ Object 



47
48
49
50
51
 
# File 'lib/rubocop/cop/internal_affairs/redundant_message_argument.rb', line 47

def autocorrect(node)
  range = offending_range(node)

  ->(corrector) { corrector.remove(range) }
end

#on_send(node) ⇒ Object 



39
40
41
42
43
44
45
 
# File 'lib/rubocop/cop/internal_affairs/redundant_message_argument.rb', line 39

def on_send(node)
  node_type_check(node) do |node_arg, kwargs|
    find_offending_argument(node_arg, kwargs) do |pair|
      add_offense(pair)
    end
  end
end