Class: RuboCop::Cop::Style::OpMethod

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/style/op_method.rb

Overview

This cop makes sure that certain operator methods have their sole parameter named other.

Constant Summary collapse

MSG = 
'When defining the `%s` operator, name its argument `other`.'
BLACKLISTED = 
[:+@, :-@, :[], :[]=, :<<]
TARGET_ARGS = 
[s(:args, s(:arg, :other)), s(:args, s(:arg, :_other))]

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #debug?, #display_cop_names?, #exclude_file?, #include_file?, inherited, #initialize, #join_force?, lint?, #message, non_rails, qualified_cop_name, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

block_length, command?, comment_line?, const_name, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes

Methods included from PathUtil

match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_def(node) ⇒ Object 



15
16
17
18
19
20
21
 
# File 'lib/rubocop/cop/style/op_method.rb', line 15

def on_def(node)
  name, args, _body = *node
  return unless name !~ /\A\w/ && !BLACKLISTED.include?(name) &&
    args.children.size == 1 && !TARGET_ARGS.include?(args)

  add_offense(args.children[0], :expression, format(MSG, name))
end