Class: RuboCop::Cop::Style::NilComparison

Inherits:
Cop
  • Object
show all
Includes:
ConfigurableEnforcedStyle
Defined in:
lib/rubocop/cop/style/nil_comparison.rb

Overview

This cop checks for comparison of something with nil using `==` and `nil?`.

Supported styles are: predicate, comparison.

Examples:

EnforcedStyle: predicate (default)


# bad
if x == nil
end

# good
if x.nil?
end

EnforcedStyle: comparison


# bad
if x.nil?
end

# good
if x == nil
end

Constant Summary collapse

PREDICATE_MSG =
'Prefer the use of the `nil?` predicate.'
EXPLICIT_MSG =
'Prefer the use of the `==` comparison.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

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 AST::Sexp

#s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object


46
47
48
49
50
51
52
53
# File 'lib/rubocop/cop/style/nil_comparison.rb', line 46

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

#on_send(node) ⇒ Object


40
41
42
43
44
# File 'lib/rubocop/cop/style/nil_comparison.rb', line 40

def on_send(node)
  style_check?(node) do
    add_offense(node, location: :selector)
  end
end