Sha256: 988288d935df3fbc5c43c4f6a677215b2cfabbf06f96f1e32f6962529a473995
Contents?: true
Size: 1.06 KB
Versions: 40
Compression:
Stored size: 1.06 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module Naming
# This cop makes sure that certain binary operator methods have their
# sole parameter named `other`.
#
# @example
#
# # bad
# def +(amount); end
#
# # good
# def +(other); end
class BinaryOperatorParameterName < Cop
MSG = 'When defining the `%<opr>s` operator, ' \
'name its argument `other`.'
OP_LIKE_METHODS = %i[eql? equal?].freeze
BLACKLISTED = %i[+@ -@ [] []= << === `].freeze
def_node_matcher :op_method_candidate?, <<~PATTERN
(def [#op_method? $_] (args $(arg [!:other !:_other])) _)
PATTERN
def on_def(node)
op_method_candidate?(node) do |name, arg|
add_offense(arg, message: format(MSG, opr: name))
end
end
private
def op_method?(name)
return false if BLACKLISTED.include?(name)
name !~ /\A\w/ || OP_LIKE_METHODS.include?(name)
end
end
end
end
end
Version data entries
40 entries across 29 versions & 5 rubygems