Sha256: 1ea89291b61bfe79b348d63723c4e0b84fe8116dbf5d9003d7bbac40749853c2
Contents?: true
Size: 1.57 KB
Versions: 23
Compression:
Stored size: 1.57 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module Lint
# This cop checks for uses of numbered parameter assignment.
# It emulates the following warning in Ruby 2.7:
#
# % ruby -ve '_1 = :value'
# ruby 2.7.2p137 (2020-10-01 revision 5445e04352) [x86_64-darwin19]
# -e:1: warning: `_1' is reserved for numbered parameter; consider another name
#
# Assiging to numbered parameter (from `_1` to `_9`) cause an error in Ruby 3.0.
#
# % ruby -ve '_1 = :value'
# ruby 3.0.0p0 (2020-12-25 revision 95aff21468) [x86_64-darwin19]
# -e:1: _1 is reserved for numbered parameter
#
# NOTE: The parametered parameters are from `_1` to `_9`. This cop checks `_0`, and over `_10`
# as well to prevent confusion.
#
# @example
#
# # bad
# _1 = :value
#
# # good
# non_numbered_parameter_name = :value
#
class NumberedParameterAssignment < Base
NUM_PARAM_MSG = '`_%<number>s` is reserved for numbered parameter; consider another name.'
LVAR_MSG = '`_%<number>s` is similar to numbered parameter; consider another name.'
NUMBERED_PARAMETER_RANGE = (1..9).freeze
def on_lvasgn(node)
lhs, _rhs = *node
return unless /\A_(\d+)\z/ =~ lhs
number = Regexp.last_match(1).to_i
template = NUMBERED_PARAMETER_RANGE.include?(number) ? NUM_PARAM_MSG : LVAR_MSG
add_offense(node, message: format(template, number: number))
end
end
end
end
end
Version data entries
23 entries across 23 versions & 3 rubygems