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`.'
OP_LIKE_METHODS =
[:eql?, :equal?]
BLACKLISTED =
[:[email protected], :[email protected], :[], :[]=, :<<]
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_name_with_namespace, cop_type, #debug?, #display_cop_names?, 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

begins_its_line?, 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, within_node?

Methods included from PathUtil

issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_def(node) ⇒ Object


17
18
19
20
21
22
23
24
# File 'lib/rubocop/cop/style/op_method.rb', line 17

def on_def(node)
  name, args, _body = *node
  return unless op_method?(name) &&
                args.children.size == 1 &&
                !TARGET_ARGS.include?(args)

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

#op_method?(name) ⇒ Boolean

Returns:

  • (Boolean)

26
27
28
29
# File 'lib/rubocop/cop/style/op_method.rb', line 26

def op_method?(name)
  return false if BLACKLISTED.include?(name)
  name !~ /\A\w/ || OP_LIKE_METHODS.include?(name)
end