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 binary operator methods have their sole parameter named ‘other`.

Examples:


# bad
def +(amount); end

# good
def +(other); end

Constant Summary collapse

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

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, 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, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #duplicate_location?, #excluded_file?, #extra_details?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from 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 IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_def(node) ⇒ Object 



28
29
30
31
32
33
34
35
 
# File 'lib/rubocop/cop/style/op_method.rb', line 28

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

  add_offense(args.children.first, :expression, format(MSG, name))
end

#op_method?(name) ⇒ Boolean

Returns:

  • (Boolean) 


37
38
39
40
 
# File 'lib/rubocop/cop/style/op_method.rb', line 37

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