Sha256: 312f2d905abf688b2980239d0e246b436cca1caacfac8dc975c9296609fa12ac
Contents?: true
Size: 1.77 KB
Versions: 6778
Compression:
Stored size: 1.77 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module Style
# This cop checks for comparison of something with nil using `==` and
# `nil?`.
#
# Supported styles are: predicate, comparison.
#
# @example EnforcedStyle: predicate (default)
#
# # bad
# if x == nil
# end
#
# # good
# if x.nil?
# end
#
# @example EnforcedStyle: comparison
#
# # bad
# if x.nil?
# end
#
# # good
# if x == nil
# end
#
class NilComparison < Cop
include ConfigurableEnforcedStyle
PREDICATE_MSG = 'Prefer the use of the `nil?` predicate.'.freeze
EXPLICIT_MSG = 'Prefer the use of the `==` comparison.'.freeze
def_node_matcher :nil_comparison?, '(send _ {:== :===} nil)'
def_node_matcher :nil_check?, '(send _ :nil?)'
def on_send(node)
style_check?(node) do
add_offense(node, location: :selector)
end
end
def autocorrect(node)
new_code = if prefer_comparison?
node.source.sub('.nil?', ' == nil')
else
node.source.sub(/\s*={2,3}\s*nil/, '.nil?')
end
->(corrector) { corrector.replace(node.source_range, new_code) }
end
private
def message(_node)
prefer_comparison? ? EXPLICIT_MSG : PREDICATE_MSG
end
def style_check?(node, &block)
if prefer_comparison?
nil_check?(node, &block)
else
nil_comparison?(node, &block)
end
end
def prefer_comparison?
style == :comparison
end
end
end
end
end
Version data entries
6,778 entries across 6,772 versions & 24 rubygems