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

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
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`.'
RESTRICT_ON_SEND = 
%i[add_offense].freeze

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from RuboCop::Cop::IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#message_method_call(node) ⇒ Object 



42
 
# File 'lib/rubocop/cop/internal_affairs/redundant_message_argument.rb', line 42

def_node_matcher :message_method_call, '(send nil? :message $_node)'

#node_type_check(node) ⇒ Object 



30
31
32
 
# File 'lib/rubocop/cop/internal_affairs/redundant_message_argument.rb', line 30

def_node_matcher :node_type_check, <<~PATTERN
  (send nil? :add_offense $_node $hash)
PATTERN

#on_send(node) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/rubocop/cop/internal_affairs/redundant_message_argument.rb', line 44

def on_send(node)
  node_type_check(node) do |node_arg, kwargs|
    find_offending_argument(node_arg, kwargs) do |pair|
      add_offense(pair) do |corrector|
        range = offending_range(pair)

        corrector.remove(range)
      end
    end
  end
end

#redundant_message_argument(node) ⇒ Object 



35
36
37
38
39
 
# File 'lib/rubocop/cop/internal_affairs/redundant_message_argument.rb', line 35

def_node_matcher :redundant_message_argument, <<~PATTERN
  (pair
    (sym :message)
    ${(const nil? :MSG) (send nil? :message) (send nil? :message _)})
PATTERN